订阅系统事件（卡死事件）

HiAppEvent提供接口用于订阅系统卡死事件。

接口说明

API接口的具体使用说明（参数使用限制、具体取值范围等）请参考应用事件打点API文档。

接口名 描述
addWatcher(watcher: Watcher): AppEventPackageHolder 添加应用事件观察者，以添加对应用事件的订阅。
removeWatcher(watcher: Watcher): void 移除应用事件观察者，以移除对应用事件的订阅。

卡死事件信息中params属性的详细描述如下：

params属性：

名称 类型 说明
time number 事件触发时间，单位为毫秒。
foreground boolean 应用是否处于前台状态。
bundle_version string 应用版本。
bundle_name string 应用名称。
process_name string 应用的进程名称。
pid number 应用的进程id。
uid number 应用的用户id。
uuid string 故障id。
exception object 异常信息，详见exception属性。
hilog string[] 日志信息。
event_handler string[] 主线程未处理消息。
event_handler_size_3s string THREAD_BLOCK事件3s时任务栈中任务数。
event_handler_size_6s string THREAD_BLOCK事件6s时任务栈中任务数。
peer_binder string[] binder调用信息。
threads object[] 全量线程调用栈，详见thread属性。
memory object 内存信息，详见memory属性。

exception属性：

名称 类型 说明
name string 异常类型。
message string 异常原因。

thread属性：

名称 类型 说明
thread_name string 线程名。
tid number 线程id。
frames object[] 线程调用栈，详见frame属性。

frame属性：

名称 类型 说明
symbol string 函数名称。
file string 文件名。
buildId string 文件唯一标识。
pc string pc寄存器地址。
offset number 函数偏移量。

memory属性：

名称 类型 说明
rss number 进程实际占用内存大小，单位KB。
vss number 进程向系统申请的虚拟内存大小，单位KB。
pss number 进程实际使用的物理内存大小，单位KB。
sys_free_mem number 空闲内存大小，单位KB。
sys_avail_mem number 可用内存大小，单位KB。
sys_total_mem number 总内存大小，单位KB。

开发步骤

以实现对用户点击按钮触发卡死场景生成的卡死事件订阅为例，说明开发步骤。

  1. 编辑工程中的“entry > src > main > ets > entryability > EntryAbility.ets”文件，在onCreate函数中添加系统事件的订阅，完整示例代码如下：

     hiAppEvent.addWatcher({
   // 开发者可以自定义观察者名称，系统会使用名称来标识不同的观察者
   name: "watcher3",
   // 开发者可以订阅感兴趣的系统事件，此处是订阅了卡死事件
   appEventFilters: [
     {
       domain: hiAppEvent.domain.OS,
       names: [hiAppEvent.event.APP_FREEZE]
     }
   ],
   // 开发者可以自行实现订阅实时回调函数，以便对订阅获取到的事件数据进行自定义处理
   onReceive: (domain: string, appEventGroups: Array<hiAppEvent.AppEventGroup>) => {
     hilog.info(0x0000, 'testTag', `HiAppEvent onReceive: domain=${domain}`);
     for (const eventGroup of appEventGroups) {
       // 开发者可以根据事件集合中的事件名称区分不同的系统事件
       hilog.info(0x0000, 'testTag', `HiAppEvent eventName=${eventGroup.name}`);
       for (const eventInfo of eventGroup.appEventInfos) {
         // 开发者可以对事件集合中的事件数据进行自定义处理，此处是将事件数据打印在日志中
         hilog.info(0x0000, 'testTag', `HiAppEvent eventInfo.domain=${eventInfo.domain}`);
         hilog.info(0x0000, 'testTag', `HiAppEvent eventInfo.name=${eventInfo.name}`);
         hilog.info(0x0000, 'testTag', `HiAppEvent eventInfo.eventType=${eventInfo.eventType}`);
         // 开发者可以获取到卡死事件发生的时间戳
         hilog.info(0x0000, 'testTag', `HiAppEvent eventInfo.params.time=${eventInfo.params['time']}`);
         // 开发者可以获取到卡死应用的前后台状态
         hilog.info(0x0000, 'testTag', `HiAppEvent eventInfo.params.foreground=${eventInfo.params['foreground']}`);
         // 开发者可以获取到卡死应用的版本信息
         hilog.info(0x0000, 'testTag', `HiAppEvent eventInfo.params.bundle_version=${eventInfo.params['bundle_version']}`);
         // 开发者可以获取到卡死应用的包名
         hilog.info(0x0000, 'testTag', `HiAppEvent eventInfo.params.bundle_name=${eventInfo.params['bundle_name']}`);
         // 开发者可以获取到卡死应用的进程名称
         hilog.info(0x0000, 'testTag', `HiAppEvent eventInfo.params.process_name=${eventInfo.params['process_name']}`);
         // 开发者可以获取到卡死应用的进程id
         hilog.info(0x0000, 'testTag', `HiAppEvent eventInfo.params.pid=${eventInfo.params['pid']}`);
         hilog.info(0x0000, 'testTag', `HiAppEvent eventInfo.params.uid=${eventInfo.params['uid']}`);
         hilog.info(0x0000, 'testTag', `HiAppEvent eventInfo.params.uuid=${eventInfo.params['uuid']}`);
         // 开发者可以获取到卡死事件发生的异常类型、异常原因
         hilog.info(0x0000, 'testTag', `HiAppEvent eventInfo.params.exception=${JSON.stringify(eventInfo.params['exception'])}`);
         // 开发者可以获取到卡死事件发生时日志信息
         hilog.info(0x0000, 'testTag', `HiAppEvent eventInfo.params.hilog.size=${eventInfo.params['hilog'].length}`);
         // 开发者可以获取到卡死事件发生时主线程未处理消息
         hilog.info(0x0000, 'testTag', `HiAppEvent eventInfo.params.event_handler.size=${eventInfo.params['event_handler'].length}`);
         hilog.info(0x0000, 'testTag', `HiAppEvent eventInfo.params.event_handler_size_3s=${eventInfo.params['event_handler_size_3s']}`);
         hilog.info(0x0000, 'testTag', `HiAppEvent eventInfo.params.event_handler_size_6s=${eventInfo.params['event_handler_size_6s']}`);
         // 开发者可以获取到卡死事件发生时同步binder调用信息
         hilog.info(0x0000, 'testTag', `HiAppEvent eventInfo.params.peer_binder.size=${eventInfo.params['peer_binder'].length}`);
         // 开发者可以获取到卡死事件发生时全量线程调用栈
         hilog.info(0x0000, 'testTag', `HiAppEvent eventInfo.params.threads.size=${eventInfo.params['threads'].length}`);
         // 开发者可以获取到卡死事件发生时内存信息
         hilog.info(0x0000, 'testTag', `HiAppEvent eventInfo.params.memory=${JSON.stringify(eventInfo.params['memory'])}`);
       }
     }
   }
 });

  2. 编辑工程中的“entry > src > main > ets > pages > Index.ets”文件，添加按钮并在其onClick函数构造卡死场景，以触发卡死事件，完整示例代码如下：

     Button("appFreeze").onClick(()=>{
   // 在按钮点击函数中构造一个freeze场景，触发应用卡死事件
   setTimeout(() => {
     while (true) {}
   }, 1000)
 })

  3. 点击IDE界面中的运行按钮，运行应用工程，然后在应用界面中点击按钮“appFreeze”，触发一次卡死事件。

  4. 应用工程卡死恢复运行后可以在Log窗口看到对系统事件数据的处理日志：

    HiAppEvent onReceive: domain=OS
HiAppEvent eventName=APP_FREEZE
HiAppEvent eventInfo.domain=OS
HiAppEvent eventInfo.name=APP_FREEZE
HiAppEvent eventInfo.eventType=1
HiAppEvent eventInfo.params.time=1702553728887
HiAppEvent eventInfo.params.foreground=true
HiAppEvent eventInfo.params.bundle_version=1.0.0
HiAppEvent eventInfo.params.bundle_name=com.example.myapplication
HiAppEvent eventInfo.params.process_name=com.example.myapplication
HiAppEvent eventInfo.params.pid=2978
HiAppEvent eventInfo.params.uid=20010043
HiAppEvent eventInfo.params.uuid=...
HiAppEvent eventInfo.params.exception={"message":"App main thread is not response!","name":"THREAD_BLOCK_6S"}
HiAppEvent eventInfo.params.hilog.size=7
HiAppEvent eventInfo.params.event_handler.size=3
HiAppEvent eventInfo.params.event_handler_size_3s=2
HiAppEvent eventInfo.params.event_handler_size_6s=3
HiAppEvent eventInfo.params.peer_binder.size=0
HiAppEvent eventInfo.params.threads.size=22
HiAppEvent eventInfo.params.memory={"pss":0,"rss":0,"sys_avail_mem":947700,"sys_free_mem":441064,"sys_total_mem":1992724,"vss":0}