1# 订阅卡死事件（ArkTS）
2
3## 接口说明
4
5API接口的具体使用说明（参数使用限制、具体取值范围等）请参考[应用事件打点API文档](../reference/apis-performance-analysis-kit/js-apis-hiviewdfx-hiappevent.md)。
6
7**事件自定义参数设置接口功能介绍：**
8
9| 接口名                                              | 描述                                         |
10| --------------------------------------------------- | -------------------------------------------- |
11| setEventParam(params: Record<string, ParamType>, domain: string, name?: string): Promise<void> | 事件自定义参数设置方法。 |
12
13**订阅接口功能介绍：**
14
15| 接口名                                              | 描述                                         |
16| --------------------------------------------------- | -------------------------------------------- |
17| addWatcher(watcher: Watcher): AppEventPackageHolder | 添加应用事件观察者，以添加对应用事件的订阅。 |
18| removeWatcher(watcher: Watcher): void               | 移除应用事件观察者，以移除对应用事件的订阅。 |
19
20## 开发步骤
21
22以实现对用户点击按钮触发卡死场景生成的卡死事件订阅为例，说明开发步骤。
23
241. 新建一个ArkTS应用工程，编辑工程中的“entry > src > main > ets  > entryability > EntryAbility.ets”文件，导入依赖模块：
25
26   ```ts
27   import { BusinessError } from '@kit.BasicServicesKit';
28   import { hiAppEvent, hilog } from '@kit.PerformanceAnalysisKit';
29   ```
30
312. 编辑工程中的“entry > src > main > ets  > entryability > EntryAbility.ets”文件，在onCreate函数中设置事件的自定义参数，示例代码如下：
32
33   ```ts
34    // 开发者完成参数键值对赋值
35    let params: Record<string, hiAppEvent.ParamType> = {
36      "test_data": 100,
37    };
38    // 开发者可以设置卡死事件的自定义参数
39    hiAppEvent.setEventParam(params, hiAppEvent.domain.OS, hiAppEvent.event.APP_FREEZE).then(() => {
40      hilog.info(0x0000, 'testTag', `HiAppEvent success to set svent param`);
41    }).catch((err: BusinessError) => {
42      hilog.error(0x0000, 'testTag', `HiAppEvent code: ${err.code}, message: ${err.message}`);
43    });
44   ```
45
463. 编辑工程中的“entry > src > main > ets  > entryability > EntryAbility.ets”文件，在onCreate函数中添加系统事件的订阅，示例代码如下：
47
48   ```ts
49    hiAppEvent.addWatcher({
50      // 开发者可以自定义观察者名称，系统会使用名称来标识不同的观察者
51      name: "watcher",
52      // 开发者可以订阅感兴趣的系统事件，此处是订阅了卡死事件
53      appEventFilters: [
54        {
55          domain: hiAppEvent.domain.OS,
56          names: [hiAppEvent.event.APP_FREEZE]
57        }
58      ],
59      // 开发者可以自行实现订阅实时回调函数，以便对订阅获取到的事件数据进行自定义处理
60      onReceive: (domain: string, appEventGroups: Array<hiAppEvent.AppEventGroup>) => {
61        hilog.info(0x0000, 'testTag', `HiAppEvent onReceive: domain=${domain}`);
62        for (const eventGroup of appEventGroups) {
63          // 开发者可以根据事件集合中的事件名称区分不同的系统事件
64          hilog.info(0x0000, 'testTag', `HiAppEvent eventName=${eventGroup.name}`);
65          for (const eventInfo of eventGroup.appEventInfos) {
66            // 开发者可以对事件集合中的事件数据进行自定义处理，此处是将事件数据打印在日志中
67            hilog.info(0x0000, 'testTag', `HiAppEvent eventInfo.domain=${eventInfo.domain}`);
68            hilog.info(0x0000, 'testTag', `HiAppEvent eventInfo.name=${eventInfo.name}`);
69            hilog.info(0x0000, 'testTag', `HiAppEvent eventInfo.eventType=${eventInfo.eventType}`);
70            // 开发者可以获取到卡死事件发生的时间戳
71            hilog.info(0x0000, 'testTag', `HiAppEvent eventInfo.params.time=${eventInfo.params['time']}`);
72            // 开发者可以获取到卡死应用的前后台状态
73            hilog.info(0x0000, 'testTag', `HiAppEvent eventInfo.params.foreground=${eventInfo.params['foreground']}`);
74            // 开发者可以获取到卡死应用的版本信息
75            hilog.info(0x0000, 'testTag', `HiAppEvent eventInfo.params.bundle_version=${eventInfo.params['bundle_version']}`);
76            // 开发者可以获取到卡死应用的包名
77            hilog.info(0x0000, 'testTag', `HiAppEvent eventInfo.params.bundle_name=${eventInfo.params['bundle_name']}`);
78            // 开发者可以获取到卡死应用的进程名称
79            hilog.info(0x0000, 'testTag', `HiAppEvent eventInfo.params.process_name=${eventInfo.params['process_name']}`);
80            // 开发者可以获取到卡死应用的进程id
81            hilog.info(0x0000, 'testTag', `HiAppEvent eventInfo.params.pid=${eventInfo.params['pid']}`);
82            hilog.info(0x0000, 'testTag', `HiAppEvent eventInfo.params.uid=${eventInfo.params['uid']}`);
83            hilog.info(0x0000, 'testTag', `HiAppEvent eventInfo.params.uuid=${eventInfo.params['uuid']}`);
84            // 开发者可以获取到卡死事件发生的异常类型、异常原因
85            hilog.info(0x0000, 'testTag', `HiAppEvent eventInfo.params.exception=${JSON.stringify(eventInfo.params['exception'])}`);
86            // 开发者可以获取到卡死事件发生时日志信息
87            hilog.info(0x0000, 'testTag', `HiAppEvent eventInfo.params.hilog.size=${eventInfo.params['hilog'].length}`);
88            // 开发者可以获取到卡死事件发生时主线程未处理消息
89            hilog.info(0x0000, 'testTag', `HiAppEvent eventInfo.params.event_handler.size=${eventInfo.params['event_handler'].length}`);
90            hilog.info(0x0000, 'testTag', `HiAppEvent eventInfo.params.event_handler_size_3s=${eventInfo.params['event_handler_size_3s']}`);
91            hilog.info(0x0000, 'testTag', `HiAppEvent eventInfo.params.event_handler_size_6s=${eventInfo.params['event_handler_size_6s']}`);
92            // 开发者可以获取到卡死事件发生时同步binder调用信息
93            hilog.info(0x0000, 'testTag', `HiAppEvent eventInfo.params.peer_binder.size=${eventInfo.params['peer_binder'].length}`);
94            // 开发者可以获取到卡死事件发生时全量线程调用栈
95            hilog.info(0x0000, 'testTag', `HiAppEvent eventInfo.params.threads.size=${eventInfo.params['threads'].length}`);
96            // 开发者可以获取到卡死事件发生时内存信息
97            hilog.info(0x0000, 'testTag', `HiAppEvent eventInfo.params.memory=${JSON.stringify(eventInfo.params['memory'])}`);
98            // 开发者可以获取到卡死事件发生时的故障日志文件
99            hilog.info(0x0000, 'testTag', `HiAppEvent eventInfo.params.external_log=${JSON.stringify(eventInfo.params['external_log'])}`);
100            hilog.info(0x0000, 'testTag', `HiAppEvent eventInfo.params.log_over_limit=${eventInfo.params['log_over_limit']}`);
101            // 开发者可以获取到卡死事件的自定义数据test_data
102            hilog.info(0x0000, 'testTag', `HiAppEvent eventInfo.params.test_data=${eventInfo.params['test_data']}`);
103          }
104        }
105      }
106    });
107   ```
108
1094. 编辑工程中的“entry > src > main > ets  > pages > Index.ets”文件，添加按钮并在其onClick函数构造卡死场景，以触发卡死事件，示例代码如下：
110
111   ```ts
112    Button("appFreeze").onClick(()=>{
113      // 在按钮点击函数中构造一个freeze场景，触发应用卡死事件
114      setTimeout(() => {
115        while (true) {}
116      }, 1000)
117    })
118   ```
119
1205. 点击DevEco Studio界面中的运行按钮，运行应用工程，然后在应用界面中点击按钮“appFreeze”，触发一次卡死事件。
121
1226. 应用卡死退出后，重新进入应用可以在Log窗口看到对系统事件数据的处理日志：
123
124   ```text
125   HiAppEvent onReceive: domain=OS
126   HiAppEvent eventName=APP_FREEZE
127   HiAppEvent eventInfo.domain=OS
128   HiAppEvent eventInfo.name=APP_FREEZE
129   HiAppEvent eventInfo.eventType=1
130   HiAppEvent eventInfo.params.time=1711440881768
131   HiAppEvent eventInfo.params.foreground=true
132   HiAppEvent eventInfo.params.bundle_version=1.0.0
133   HiAppEvent eventInfo.params.bundle_name=com.example.myapplication
134   HiAppEvent eventInfo.params.process_name=com.example.myapplication
135   HiAppEvent eventInfo.params.pid=3197
136   HiAppEvent eventInfo.params.uid=20010043
137   HiAppEvent eventInfo.params.uuid=27fac7098da46efe1cae9904946ec06c5acc91689c365efeefb7a23a0c37df77
138   HiAppEvent eventInfo.params.exception={"message":"App main thread is not response!","name":"THREAD_BLOCK_6S"}
139   HiAppEvent eventInfo.params.hilog.size=77
140   HiAppEvent eventInfo.params.event_handler.size=6
141   HiAppEvent eventInfo.params.event_handler_size_3s=5
142   HiAppEvent eventInfo.params.event_handler_size_6s=6
143   HiAppEvent eventInfo.params.peer_binder.size=0
144   HiAppEvent eventInfo.params.threads.size=28
145   HiAppEvent eventInfo.params.memory={"pss":0,"rss":0,"sys_avail_mem":1361464,"sys_free_mem":796232,"sys_total_mem":1992340,"vss":0}
146   HiAppEvent eventInfo.params.external_log=["/data/storage/el2/log/hiappevent/APP_FREEZE_1711440899240_3197.log"]
147   HiAppEvent eventInfo.params.log_over_limit=false
148   HiAppEvent eventInfo.params.test_data=100
149   ```
150