订阅崩溃事件（ArkTS）
接口说明
API接口的具体使用说明（参数使用限制、具体取值范围等）请参考应用事件打点API文档。
说明：
使用ArkTS接口订阅崩溃事件，包含JsError和NativeCrash两种崩溃类型。
事件自定义参数设置接口功能介绍：
| 接口名 | 描述 |
|---|---|
| setEventParam(params: Record<string, ParamType>, domain: string, name?: string): Promise<void> | 事件自定义参数设置方法。 |
订阅接口功能介绍：
| 接口名 | 描述 |
|---|---|
| addWatcher(watcher: Watcher): AppEventPackageHolder | 添加应用事件观察者，以添加对应用事件的订阅。 |
| removeWatcher(watcher: Watcher): void | 移除应用事件观察者，以移除对应用事件的订阅。 |
开发步骤
以实现对用户点击按钮触发崩溃场景生成的崩溃事件订阅为例，说明开发步骤。
-
新建一个ArkTS应用工程，编辑工程中的“entry > src > main > ets > entryability > EntryAbility.ets”文件，导入依赖模块：
import { BusinessError } from '@kit.BasicServicesKit'; import { hiAppEvent, hilog } from '@kit.PerformanceAnalysisKit'; -
编辑工程中的“entry > src > main > ets > entryability > EntryAbility.ets”文件，在onCreate函数中设置事件的自定义参数，示例代码如下：
// 开发者完成参数键值对赋值 let params: Record<string, hiAppEvent.ParamType> = { "test_data": 100, }; // 开发者可以设置崩溃事件的自定义参数 hiAppEvent.setEventParam(params, hiAppEvent.domain.OS, hiAppEvent.event.APP_CRASH).then(() => { hilog.info(0x0000, 'testTag', `HiAppEvent success to set svent param`); }).catch((err: BusinessError) => { hilog.error(0x0000, 'testTag', `HiAppEvent code: ${err.code}, message: ${err.message}`); }); -
编辑工程中的“entry > src > main > ets > entryability > EntryAbility.ets”文件，在onCreate函数中添加系统事件的订阅，示例代码如下：
hiAppEvent.addWatcher({ // 开发者可以自定义观察者名称，系统会使用名称来标识不同的观察者 name: "watcher", // 开发者可以订阅感兴趣的系统事件，此处是订阅了崩溃事件 appEventFilters: [ { domain: hiAppEvent.domain.OS, names: [hiAppEvent.event.APP_CRASH] } ], // 开发者可以自行实现订阅实时回调函数，以便对订阅获取到的事件数据进行自定义处理 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.crash_type=${eventInfo.params['crash_type']}`); // 开发者可以获取到崩溃应用的前后台状态 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']}`); // 开发者可以获取到崩溃应用的进程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.external_log=${JSON.stringify(eventInfo.params['external_log'])}`); hilog.info(0x0000, 'testTag', `HiAppEvent eventInfo.params.log_over_limit=${eventInfo.params['log_over_limit']}`); // 开发者可以获取到崩溃事件的自定义数据test_data hilog.info(0x0000, 'testTag', `HiAppEvent eventInfo.params.test_data=${eventInfo.params['test_data']}`); } } } }); -
编辑工程中的“entry > src > main > ets > pages > Index.ets”文件，添加按钮并在其onClick函数构造崩溃场景，以触发崩溃事件，示例代码如下：
Button("appCrash").onClick(()=>{ // 在按钮点击函数中构造一个crash场景，触发应用崩溃事件 let result: object = JSON.parse(""); }) -
点击DevEco Studio界面中的运行按钮，运行应用工程，然后在应用界面中点击按钮“appCrash”，触发一次崩溃事件。崩溃事件发生后，系统会根据崩溃类型（JsError或NativeCrash）采用不同的栈回溯方式生成崩溃日志，然后再进行回调。其中NativeCrash栈回溯耗时约2秒，实际耗时与业务线程数量、进程间通信耗时有关。JsError触发进程内栈回溯，NativeCrash触发进程外栈回溯，因此NativeCrash栈回溯会比JsError栈回溯更耗时。用户可以订阅崩溃事件，栈回溯完成后会异步上报，不会阻塞当前业务。
-
若应用未捕获崩溃异常，则系统处理崩溃后应用退出，应用下次启动后HiAppEvent将崩溃事件上报给应用已注册的监听，完成回调。
若应用主动捕获崩溃异常，如下两种场景，HiAppEvent事件将会在应用退出前回调。
场景1：异常处理中未主动退出，应用发生崩溃后将不会退出。例如采用errorManger.on方法捕获JsError崩溃；应用主动注册NativeCrash崩溃信号处理函数未主动退出。
场景2：异常处理耗时太久，应用退出时机延后。
HiAppEvent上报事件完成回调后，可以在Log窗口看到对系统事件数据的处理日志：HiAppEvent onReceive: domain=OS HiAppEvent eventName=APP_CRASH HiAppEvent eventInfo.domain=OS HiAppEvent eventInfo.name=APP_CRASH HiAppEvent eventInfo.eventType=1 HiAppEvent eventInfo.params.time=1711440614001 HiAppEvent eventInfo.params.crash_type=JsError HiAppEvent eventInfo.params.foreground=true HiAppEvent eventInfo.params.bundle_version=1.0.0 HiAppEvent eventInfo.params.bundle_name=com.example.myapplication HiAppEvent eventInfo.params.pid=2043 HiAppEvent eventInfo.params.uid=20010043 HiAppEvent eventInfo.params.uuid=b1e953ba0022c112e4502e28e8b3ad6d95cf3c87bae74068038f03b38ce7f66a HiAppEvent eventInfo.params.exception={"message":"Unexpected Text in JSON","name":"SyntaxError","stack":"at anonymous (entry/src/main/ets/pages/Index.ets:55:34)"} HiAppEvent eventInfo.params.hilog.size=90 HiAppEvent eventInfo.params.external_log=["/data/storage/el2/log/hiappevent/APP_CRASH_1711440614112_2043.log"] HiAppEvent eventInfo.params.log_over_limit=false HiAppEvent eventInfo.params.test_data=100