基于HiAppEvent能力的应用崩溃监控上报

HiAppEvent介绍：

HiAppEvent的接口设计，由系统决定回调的时机。使用这种机制，可以获取的应用崩溃事件结构化日志。

HiAppEvent运营&运维事件软件模块，用于连接APP开发者、APM上传模块、HiView故障维测服务。支撑应用开发者完成运营和运维的数据分析工作。

主要通过如下措施支持开发者快速完成APP线上的运营和运维功能：

• 措施1：开放系统事件订阅API，可以订阅到系统检测到APP相关事件，包括崩溃、卡死等。
• 措施2：开放自定义事件API，开发者可以本地记录事件、本地记录用户属性。
• 措施3：开放故障日志，开发者订阅系统事件后同步可获取相关故障的日志。
• 措施4：开放数据处理者API，开发者可以选择华为提供的分析服务。

事件定义说明事件领域（domain）用于标识事件的领域，建议设置为业务模块名称，以便于区分不同的业务模块。事件名称(name)用于指定事件的名称，建议设置为具体的业务名称，以便于描述实际的业务意义。

事件类型（eventType）用于指定事件的类型，支持以下四种类型事件。

• 行为事件：用于记录用户日常操作行为的事件，例如按钮点击、界面跳转等行为。
• 故障事件：用于定位和分析应用故障的事件，例如界面卡顿、掉网掉话等异常。
• 统计事件：用于统计和度量应用关键行为的事件，例如对使用时长、访问数等的统计。
• 安全事件：用于记录涉及应用安全行为的事件，例如密码修改、用户授权等行为。

事件参数(params)用于指定事件的参数，每个事件可以包含一组参数，建议设置为事件属性或事件发生上下文信息，以便于描述事件的详细信息。

使用hiAppEvent进行崩溃的监听，在应用崩溃之后，用户可以通过再次进入应用，进行崩溃信息的处理。

相同能力对比：FaultLogger。

FaultLogger和HiAppEvent如何选择，区别是什么。

（1）FaultLogger是日志查询功能，开发者可以主动查询近期发生的故障日志。

（2）HiAppEvent是事件记录和监听功能，开发者可以监听行为、故障、统计、安全事件。

功能场景描述及使用场景

场景一：应用崩溃监听。

在应用发生CPP\_CRASH、JS\_CRASH、APP\_FREEZE后便于监听相应的崩溃信息进行处理。

核心代码解释

使用hiAppEvent进行崩溃的监听，在应用崩溃之后，用户可以通过再次进入应用，进行崩溃信息的处理。

代码逻辑：

1. 首先定义观察者addWatcher，以添加对应用事件的订阅。
2. 订阅崩溃事件。

核心代码如下：

添加应用崩溃事件观察者方法：

hiAppEvent.addWatcher({
  // 开发者可以自定义观察者名称，系统会使用名称来标识不同的观察者
  name: "watcher2",
  // 开发者可以订阅感兴趣的系统事件，此处是订阅了崩溃事件
  appEventFilters: [
    {
      domain: hiAppEvent.domain.OS,
      names: [hiAppEvent.event.APP_CRASH,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.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}`);
        console.log("testTag" + eventGroup.name.toString())

        if(eventGroup.name.toString() === 'APP_FREEZE'){
          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'])}`);
        }
      }
    }
  }
});

崩溃模拟：

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

Button("js-Crash").onClick(()=>{
  // 在按钮点击函数中构造一个crash场景，触发应用崩溃事件
  let result: object = JSON.parse("");
})

Button("Cpp-Crash").onClick(()=>{
  // 在按钮点击函数中构造一个crash场景，触发应用崩溃事件
  hilog.info(0x0000, 'testTag', 'Test NAPI 2 + 3 = %{public}d', testNapi.add(2, 3));
})

场景二：基于HiAppEvent能力的应用崩溃监控上报

接入云侧服务：

//配置需要上传的事件
let eventConfig: hiAppEvent.AppEventReportConfig = {
  domain: 'button',
  name: 'click',
  isRealTime: true
};
//配置要使用的华为云属性
let processor: hiAppEvent.Processor = {
  name: 'analytics_demo',
  debugMode: true,
  routeInfo: 'CN',
  onStartReport: true,
  onBackgroundReport: true,
  periodReport: 10,
  batchReport: 5,
  userIds: ['testUserIdName'],
  userProperties: ['testUserPropertyName'],
  eventConfigs: [eventConfig]
};
//添加数据处理者
this.processorId = hiAppEvent.addProcessor(processor);