• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
1# 订阅系统事件(卡死事件)
2
3HiAppEvent提供接口用于订阅系统卡死事件。
4
5## 接口说明
6
7API接口的具体使用说明(参数使用限制、具体取值范围等)请参考[应用事件打点API文档](../reference/apis-performance-analysis-kit/js-apis-hiviewdfx-hiappevent.md)。
8
9| 接口名                                              | 描述                                         |
10| --------------------------------------------------- | -------------------------------------------- |
11| addWatcher(watcher: Watcher): AppEventPackageHolder | 添加应用事件观察者,以添加对应用事件的订阅。 |
12| removeWatcher(watcher: Watcher): void               | 移除应用事件观察者,以移除对应用事件的订阅。 |
13
14卡死事件信息中params属性的详细描述如下:
15
16**params属性:**
17
18| 名称    | 类型   | 说明                       |
19| ------- | ------ | ------------------------- |
20| time     | number | 事件触发时间,单位为毫秒。 |
21| foreground | boolean | 应用是否处于前台状态。 |
22| bundle_version | string | 应用版本。 |
23| bundle_name | string | 应用名称。 |
24| process_name | string | 应用的进程名称。 |
25| pid | number | 应用的进程id。|
26| uid | number | 应用的用户id。 |
27| uuid | string | 用户标识id。 |
28| exception | object | 异常信息,详见exception属性。 |
29| hilog | string[] | 日志信息。|
30| event_handler | string[] | 主线程未处理消息。 |
31| event_handler_size_3s | string | THREAD_BLOCK事件3s时任务栈中任务数。 |
32| event_handler_size_6s | string | THREAD_BLOCK事件6s时任务栈中任务数。 |
33| peer_binder | string[] | binder调用信息。 |
34| threads | object[] | 全量线程调用栈,详见thread属性。 |
35| memory | object | 内存信息,详见memory属性。 |
36
37**exception属性:**
38
39| 名称    | 类型   | 说明                       |
40| ------- | ------ | ------------------------- |
41| name | string | 异常类型。 |
42| message | string | 异常原因。 |
43
44**thread属性:**
45
46| 名称    | 类型   | 说明                       |
47| ------- | ------ | ------------------------- |
48| thread_name | string | 线程名。 |
49| tid | number | 线程id。 |
50| frames | object[] | 线程调用栈,详见frame属性。 |
51
52**frame属性:**
53
54| 名称    | 类型   | 说明                       |
55| ------- | ------ | ------------------------- |
56| symbol | string | 函数名称。 |
57| file | string | 文件名。 |
58| buildId | string | 文件唯一标识。 |
59| pc | string | pc寄存器地址。 |
60| offset | number | 函数偏移量。 |
61
62**memory属性:**
63
64| 名称    | 类型   | 说明                       |
65| ------- | ------ | ------------------------- |
66| rss | number | 进程实际占用内存大小,单位KB。 |
67| vss | number | 进程向系统申请的虚拟内存大小,单位KB。 |
68| pss | number | 进程实际使用的物理内存大小,单位KB。 |
69| sys_free_mem | number | 空闲内存大小,单位KB。 |
70| sys_avail_mem | number | 可用内存大小,单位KB。 |
71| sys_total_mem | number | 总内存大小,单位KB。 |
72
73## 开发步骤
74
75以实现对用户点击按钮触发卡死场景生成的卡死事件订阅为例,说明开发步骤。
76
771. 编辑工程中的“entry > src > main > ets  > entryability > EntryAbility.ets”文件,在onCreate函数中添加系统事件的订阅,完整示例代码如下:
78
79   ```ts
80    hiAppEvent.addWatcher({
81      // 开发者可以自定义观察者名称,系统会使用名称来标识不同的观察者
82      name: "watcher3",
83      // 开发者可以订阅感兴趣的系统事件,此处是订阅了卡死事件
84      appEventFilters: [
85        {
86          domain: hiAppEvent.domain.OS,
87          names: [hiAppEvent.event.APP_FREEZE]
88        }
89      ],
90      // 开发者可以自行实现订阅实时回调函数,以便对订阅获取到的事件数据进行自定义处理
91      onReceive: (domain: string, appEventGroups: Array<hiAppEvent.AppEventGroup>) => {
92        hilog.info(0x0000, 'testTag', `HiAppEvent onReceive: domain=${domain}`);
93        for (const eventGroup of appEventGroups) {
94          // 开发者可以根据事件集合中的事件名称区分不同的系统事件
95          hilog.info(0x0000, 'testTag', `HiAppEvent eventName=${eventGroup.name}`);
96          for (const eventInfo of eventGroup.appEventInfos) {
97            // 开发者可以对事件集合中的事件数据进行自定义处理,此处是将事件数据打印在日志中
98            hilog.info(0x0000, 'testTag', `HiAppEvent eventInfo.domain=${eventInfo.domain}`);
99            hilog.info(0x0000, 'testTag', `HiAppEvent eventInfo.name=${eventInfo.name}`);
100            hilog.info(0x0000, 'testTag', `HiAppEvent eventInfo.eventType=${eventInfo.eventType}`);
101            // 开发者可以获取到卡死事件发生的时间戳
102            hilog.info(0x0000, 'testTag', `HiAppEvent eventInfo.params.time=${eventInfo.params['time']}`);
103            // 开发者可以获取到卡死应用的前后台状态
104            hilog.info(0x0000, 'testTag', `HiAppEvent eventInfo.params.foreground=${eventInfo.params['foreground']}`);
105            // 开发者可以获取到卡死应用的版本信息
106            hilog.info(0x0000, 'testTag', `HiAppEvent eventInfo.params.bundle_version=${eventInfo.params['bundle_version']}`);
107            // 开发者可以获取到卡死应用的包名
108            hilog.info(0x0000, 'testTag', `HiAppEvent eventInfo.params.bundle_name=${eventInfo.params['bundle_name']}`);
109            // 开发者可以获取到卡死应用的进程名称
110            hilog.info(0x0000, 'testTag', `HiAppEvent eventInfo.params.process_name=${eventInfo.params['process_name']}`);
111            // 开发者可以获取到卡死应用的进程id
112            hilog.info(0x0000, 'testTag', `HiAppEvent eventInfo.params.pid=${eventInfo.params['pid']}`);
113            hilog.info(0x0000, 'testTag', `HiAppEvent eventInfo.params.uid=${eventInfo.params['uid']}`);
114            hilog.info(0x0000, 'testTag', `HiAppEvent eventInfo.params.uuid=${eventInfo.params['uuid']}`);
115            // 开发者可以获取到卡死事件发生的异常类型、异常原因
116            hilog.info(0x0000, 'testTag', `HiAppEvent eventInfo.params.exception=${JSON.stringify(eventInfo.params['exception'])}`);
117            // 开发者可以获取到卡死事件发生时日志信息
118            hilog.info(0x0000, 'testTag', `HiAppEvent eventInfo.params.hilog.size=${eventInfo.params['hilog'].length}`);
119            // 开发者可以获取到卡死事件发生时主线程未处理消息
120            hilog.info(0x0000, 'testTag', `HiAppEvent eventInfo.params.event_handler.size=${eventInfo.params['event_handler'].length}`);
121            hilog.info(0x0000, 'testTag', `HiAppEvent eventInfo.params.event_handler_size_3s=${eventInfo.params['event_handler_size_3s']}`);
122            hilog.info(0x0000, 'testTag', `HiAppEvent eventInfo.params.event_handler_size_6s=${eventInfo.params['event_handler_size_6s']}`);
123            // 开发者可以获取到卡死事件发生时同步binder调用信息
124            hilog.info(0x0000, 'testTag', `HiAppEvent eventInfo.params.peer_binder.size=${eventInfo.params['peer_binder'].length}`);
125            // 开发者可以获取到卡死事件发生时全量线程调用栈
126            hilog.info(0x0000, 'testTag', `HiAppEvent eventInfo.params.threads.size=${eventInfo.params['threads'].length}`);
127            // 开发者可以获取到卡死事件发生时内存信息
128            hilog.info(0x0000, 'testTag', `HiAppEvent eventInfo.params.memory=${JSON.stringify(eventInfo.params['memory'])}`);
129          }
130        }
131      }
132    });
133   ```
134
1352. 编辑工程中的“entry > src > main > ets  > pages > Index.ets”文件,添加按钮并在其onClick函数构造卡死场景,以触发卡死事件,完整示例代码如下:
136
137   ```ts
138    Button("appFreeze").onClick(()=>{
139      // 在按钮点击函数中构造一个freeze场景,触发应用卡死事件
140      setTimeout(() => {
141        while (true) {}
142      }, 1000)
143    })
144   ```
145
1463. 点击IDE界面中的运行按钮,运行应用工程,然后在应用界面中点击按钮“appFreeze”,触发一次卡死事件。
147
1484. 应用工程卡死恢复运行后可以在Log窗口看到对系统事件数据的处理日志:
149
150   ```text
151   HiAppEvent onReceive: domain=OS
152   HiAppEvent eventName=APP_FREEZE
153   HiAppEvent eventInfo.domain=OS
154   HiAppEvent eventInfo.name=APP_FREEZE
155   HiAppEvent eventInfo.eventType=1
156   HiAppEvent eventInfo.params.time=1702553728887
157   HiAppEvent eventInfo.params.foreground=true
158   HiAppEvent eventInfo.params.bundle_version=1.0.0
159   HiAppEvent eventInfo.params.bundle_name=com.example.myapplication
160   HiAppEvent eventInfo.params.process_name=com.example.myapplication
161   HiAppEvent eventInfo.params.pid=2978
162   HiAppEvent eventInfo.params.uid=20010043
163   HiAppEvent eventInfo.params.uuid=...
164   HiAppEvent eventInfo.params.exception={"message":"App main thread is not response!","name":"THREAD_BLOCK_6S"}
165   HiAppEvent eventInfo.params.hilog.size=7
166   HiAppEvent eventInfo.params.event_handler.size=3
167   HiAppEvent eventInfo.params.event_handler_size_3s=2
168   HiAppEvent eventInfo.params.event_handler_size_6s=3
169   HiAppEvent eventInfo.params.peer_binder.size=0
170   HiAppEvent eventInfo.params.threads.size=22
171   HiAppEvent eventInfo.params.memory={"pss":0,"rss":0,"sys_avail_mem":947700,"sys_free_mem":441064,"sys_total_mem":1992724,"vss":0}
172   ```