• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# Hiview开发指导
2
3
4## 概述
5
6
7### 功能简介
8
9Hiview是一个跨平台的终端设备维测服务集，由插件管理平台和基于平台上运行的服务插件来构成整套系统。Hiview维测服务是由HiSysEvent事件驱动的，其核心为分布在系统各处的HiSysEvent桩点，格式化的事件会通过HiSysEvent打点API上报至Hiview进行处理，其处理流程如下图所示：
10
11**图1** Hiview模块数据交互图
12
13![Hiview_module_data_interaction](figures/Hiview_module_data_interaction.png)
14
151. 业务进程通过调用HiSysEvent模块提供的打点接口，上报打点事件信息并将其写入节点文件。
162. Hiview进程中的SysEventSource事件源会从节点中异步读取出事件信息，并将事件分发到SysEventPipeline流水线上进行处理，其中：
17   - SysEventService插件负责对事件进行校验及落盘；
18   - Faultlogger插件负责处理故障相关事件；
19   - EventLogger插件负责采集事件相关的日志信息。
203. 在流水线上完成事件处理后，还会把事件发送到平台订阅事件队列里，然后将事件派发到订阅插件进行处理，其中：
21   - FreezeDetector插件负责处理冻屏相关事件；
22   - HiCollieCollector插件负责卡死相关事件。
23
24### 基本概念
25
26在进行Hiview的开发前，开发者应了解以下基本概念：
27
28- 插件
29
30  运行在Hiview进程中，随Hiview二进制一同交付的完成独立功能的维测、故障管理模块，具有编译时可独立拆解、运行时寄宿于平台、动态配置等特性。
31
32- 流水线
33
34  事件处理插件的有序集合，进入流水线的事件会按序经过流水线上的每个插件处理。
35
36- 事件源
37
38  一种能够生产事件的特殊插件，相较普通插件，需要能够绑定流水线、生产事件并将事件分发给流水线。
39
40- 流水线组
41
42  配置在相同事件源的多个流水线被称作一个流水线组。
43
44### 运作机制
45
46Hiview支持基于插件管理平台的插件开发，提供了插件开发的相关能力，开发者可以通过在Hiview平台上新增自己的插件，来对HiSysEvent事件进行特定业务处理。在进行插件开发前，开发者应该了解插件的相关运作原理。
47
48#### 插件注册
49
50插件的注册方式有三种：
51
52| 名称               | 说明                                                         |
53| ------------------ | ------------------------------------------------------------ |
54| 静态注册           | 通过使用宏定义REGISTER(xxx);注册，该种注册方式的插件不能被卸载 |
55| 代理注册           | 通过使用宏定义REGISTER_PROXY(xxx);注册，开机不加载运行时动态加载卸载 |
56| 代理注册且开机加载 | 通过使用宏定义REGISTER_PROXY_WITH_LOADED(xxx);注册，开机加载之后再动态卸载加载 |
57
58####  插件驱动
59
60插件的事件驱动有两种方式——流水线驱动和订阅驱动，区别如下：
61
62- 流水线驱动的插件需要配置在流水线上，当事件从事件源分发到流水线后，会按序流转到流水线上配置的每个插件进行处理。
63- 订阅驱动的插件无需配置在流水线上，但是需要在插件启动时注册一个监听者到Hiview平台，并且插件本身需要实现事件监听处理函数。
64
65#### 插件包加载
66
67根据业务的需求，插件可以不用全部编译在Hiview二进制中。
68
69Hiview支持将多个插件编译成为一个独立的插件包，以独立so的形式预置到系统中，并且一个so需要对应于一个plugin_config文件，例如libxxx.z.so，对应于xxx_plugin_config配置文件。Hiview进程在启动时，会扫描系统中的插件包so以及对应的配置文件，并对插件包中实现的插件进行加载。
70
71对插件包做如下补充说明：
72
731. 插件包作为一个独立的个体在插件管理平台中运行，内部插件、流水线或者事件源都与在Hiview二进制中的插件没有功能上的差异。
74
752. 插件包中的插件可以插入到Hiview二进制中的流水线中。
76
77
783. 无论在何处的订阅者，根据其订阅的规则都可以收到全平台发送出来的相应事件。
79
80
81## 插件开发指导
82
83
84### 场景介绍
85
86当开发者需要对事件源分发过来的HiSysEvent事件进行特定业务处理的时候，需要在Hiview平台上新增一个插件，并借助该插件进行相应业务处理，下文将具体介绍如何进行Hiview插件开发。
87
88### 接口说明
89
90插件开发的相关接口如下，具体的API详见接口文档。
91
92**表1** Plugin类API接口功能介绍
93
94| 接口名                                                       | 描述                                                         |
95| ------------------------------------------------------------ | ------------------------------------------------------------ |
96| virtual void OnLoad()                                        | 插件加载函数，当插件被平台加载后调用，可以用于初始化一些数据 |
97| virtual void OnUnload()                                      | 插件卸载函数，当插件被平台卸载前调用，可以用于回收一些数据   |
98| virtual bool ReadyToLoad()                                   | 用于在Hiview启动加载插件时判断当前插件能否被加载             |
99| virtual bool OnEvent(std::shared_ptr\<Event\>& event)        | 事件处理函数，用于接收处理流水线或者平台分发过来的事件并进行业务处理 |
100| virtual bool CanProcessEvent(std::shared_ptr\<Event\> event) | 用于判断事件是否能向后流转整条流水线（当插件位于流水线上的第一个时生效） |
101| HiviewContext* GetHiviewContext()                            | 获取Hiview插件管理平台的上下文对象                           |
102
103**表2** Event类API接口功能介绍
104
105| 接口名                 | 描述                         |
106| ---------------------- | ---------------------------- |
107| domain_                | 事件领域                     |
108| eventName_             | 事件名称                     |
109| happenTime_            | 事件发生时间                 |
110| jsonExtraInfo_         | Json格式的事件数据           |
111| bool IsPipelineEvent() | 判断事件是否为流水线事件     |
112| bool HasFinish()       | 判断事件是否还能继续往后流转 |
113
114### 开发步骤
115
1161. 首先，需要定义一个继承自Plugin基类的业务插件类：
117
118   ```c++
119   #include "event.h"
120   #include "plugin.h"
121
122   class PluginExample : public Plugin {
123   public:
124       bool OnEvent(std::shared_ptr<Event>& event) override;
125       void OnLoad() override;
126       void OnUnload() override;
127   };
128   ```
129
1302. 然后，在插件类实现代码中，需要先对插件进行注册，再根据业务需要覆写实现相应的函数。
131
132   ```c++
133   #include "plugin_factory.h"
134
135   // 静态注册插件
136   REGISTER(PluginExample);
137
138   void PluginExample::OnLoad()
139   {
140       ... // 在插件加载时，可以进行插件的资源初始化工作
141       printf("PluginExample OnLoad \n");
142   }
143
144   void PluginExample::OnUnload()
145   {
146       ... // 在插件卸载时，可以进行插件的资源释放工作
147       printf("PluginExample OnUnload \n");
148   }
149
150   bool PluginExample::OnEvent(std::shared_ptr<Event>& event)
151   {
152       ... // 在事件处理函数中，可以进行对事件进行特定业务处理
153       printf("PluginExample OnEvent \n");
154
155       // 例如，插件只关注某个领域的事件，并需要将这个领域的事件信息进行日志打印处理
156       if (event->domain_ == "TEST_DOMAIN") {
157           printf("The event data received is %s \n", event->jsonExtraInfo_);
158           return true;
159       }
160
161       return false;
162   }
163   ```
164
1653. 最后，需要将插件配置在plugin_build.json文件中，随Hiview二进制一同编译：
166
167   ```json
168   {
169       "plugins": {
170           "PluginExample": {
171               "path": "plugins/PluginExample",
172               "name": "PluginExample"
173           }
174       },
175       "rules": [
176           {
177               "info": {
178                   "loadorder": {
179                       "PluginExample": {
180                           "loadtime": 0
181                       }
182                   },
183                   "pipelines": {
184                       "SysEventPipeline": [
185                          PluginExample
186                       ]
187                   }
188               }
189           }
190       ]
191   }
192   ```
193
194
195## 参考
196
197如果您想了解更多关于Hiview特性的源码及使用信息，请参考[Hiview代码仓](https://gitee.com/openharmony/hiviewdfx_hiview)。