HiAppEvent组件

• 简介

• 目录

• 编译构建

• 说明

  • 接口说明
  • 使用说明

• 相关仓

简介

HiAppEvent为OpenHarmony应用提供事件打点接口，用于帮助应用记录在运行过程中发生的故障信息、统计信息、安全信息、用户行为信息，以支撑开发者分析应用的运行情况。

图 1 HiAppEvent架构图

目录

/base/hiviewdfx/hiappevent   # hiappevent部件代码
├── frameworks               # 框架代码
│   └── native               # 打点接口的native实现代码
├── interfaces               # 对外接口存放目录
│   └── js                   # js接口
│       └── innerkits        # js接口内部实现代码
│           └── napi         # 基于napi实现的js接口代码
├── test                     # 测试用例代码

编译构建

依赖 Clang 编译器(Clang 8.0.0 )及以上，依赖C++11版本及以上。

说明

接口说明

JS接口说明

表 1 JS 打点接口介绍

表 2 JS 事件类型枚举——EventType

表 3 JS 打点配置接口介绍

表 4 JS 应用打点配置选项——ConfigOption

表 5 JS 预定义事件名称常量接口——Event

表 6 JS 预定义参数名称常量接口——Param

Native接口说明

表 1 打点接口介绍

表 2 事件参数列表构造接口介绍

表 3 打点配置接口介绍

表 4 配置项常量介绍

表 5 预定义事件名称常量介绍

表 6 预定义参数名称常量介绍

使用说明

JS接口开发实例

1. 源代码开发

   引入模块：

   import hiAppEvent from '@ohos.hiAppEvent'

2. 应用执行事件打点

   // callback方式
   hiAppEvent.write("test_event", hiAppEvent.EventType.FAULT, {"int_data":100, "str_data":"strValue"}, (err, value) => {
       if (err) {
           // 事件写入异常：事件存在异常参数或者事件校验失败不执行写入
           console.error(`failed to write event because ${err.code}`);
           return;
       }
   
       // 事件写入正常
       console.log(`success to write event: ${value}`);
   });
   
   // Promise方式
   hiAppEvent.write("test_event", hiAppEvent.EventType.FAULT, {"int_data":100, "str_data":"strValue"})
       .then((value) => {
           // 事件写入正常
           console.log(`success to write event: ${value}`);
       }).catch((err) => {
           // 事件写入异常：事件存在异常参数或者事件校验失败不执行写入
           console.error(`failed to write event because ${err.code}`);
       });

3. 应用对打点功能进行自定义配置

   // 配置应用事件打点功能开关
   hiAppEvent.configure({
       disable: true
   })
   
   // 配置事件文件目录存储限额大小
   hiAppEvent.configure({
       maxStorage: '100M'
   })

Native接口开发实例

1. 源代码开发

   引入模块：

   #include "hiappevent/hiappevent.h"

2. 应用执行事件打点

   // 1. 创建空参数list
   ParamList list = OH_HiAppEvent_CreateParamList();
   
   // 2. 向list添加要传入的键值对参数
   // 2.1 传入int32_t参数值
   int32_t num = 1;
   OH_HiAppEvent_AddInt32Param(list, "int32_key", num);
   // 2.2 传入int32_t数组参数值
   int32_t nums3[] = {1, INT32_MAX, INT32_MIN};
   OH_HiAppEvent_AddInt32ArrayParam(list, "int32_arr_key", nums3, sizeof(nums3) / sizeof(nums3[0]));
   // 2.3 传入字符串数组参数值
   char str1[] = "hello";
   char str2[] = "world";
   char* strs[] = {str1, str2};
   OH_HiAppEvent_AddStringArrayParam(list, "string_arr_key", strs, sizeof(strs) / sizeof(strs[0]));
   
   // 3. 执行打点操作
   int result = OH_HiAppEvent_Write("domain", "name", BEHAVIOR, list);
   printf("HiAppEvent logging test, res=%d\n", result);
   
   // 4. 销毁ParamLIst对象，释放内存
   OH_HiAppEvent_DestroyParamList(list);

3. 应用对打点功能进行自定义配置

   // 关闭应用打点功能
   OH_HiAppEvent_Configure(DISABLE, "true");
   
   // 配置打点数据文件目录存储限额为100M
   OH_HiAppEvent_Configure(MAX_STORAGE, "100M");

相关仓

DFX子系统

hiviewdfx_hiview

hiviewdfx_hilog

hiviewdfx_hiappevent

hiviewdfx_hisysevent

hiviewdfx_faultloggerd

hiviewdfx_hilog_lite

hiviewdfx_hievent_lite

hiviewdfx_hiview_lite