@ohos.hiAppEvent (应用打点)


@ohos.hiAppEvent (应用打点)

本模块提供了应用事件打点能力,包括对打点数据的落盘,以及对打点功能的管理配置。

说明:

  • 本模块接口从API version 9开始废弃,建议使用新接口@ohos.hiviewdfx.hiAppEvent替代。
  • 本模块首批接口从API version 7开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。

导入模块

import hiAppEvent from '@ohos.hiAppEvent';
1

使用说明

开发者在使用应用事件打点功能前,需要首先了解应用事件相关的参数规格定义。

事件名称

事件名称为string类型,字符串非空且长度在48个字符以内,有效的字符是0-9、a-z、下划线,只能以小写字母开头,不能以下划线结尾。

事件类型

事件类型为EventType枚举类型。

事件参数

事件参数为object类型,key为事件的参数名称,value为事件的参数值,其规格定义如下:

  • 参数名为string类型,字符串非空且长度在16个字符以内,有效的字符是0-9、a-z、下划线,只能以小写字母开头,不能以下划线结尾;
  • 参数值支持string、number、boolean、Array类型;
  • 参数值为string类型时,其长度需在8*1024个字符以内,超出会做截断处理;
  • 参数值为Array类型时,Array中的元素类型只能全为string、number、boolean中的一种,且元素个数需在100以内,超出会做丢弃处理;
  • 参数个数需在32以内,超出的参数会做丢弃处理。

事件回调

开发者在调用事件打点方法后,可以在回调函数中对打点返回值进行处理,当前支持callback形式和Promise形式的回调,其返回值规格定义如下:

  • 返回值为0,表示事件校验成功,将事件直接落盘到事件文件;
  • 返回值大于0,表示事件校验存在异常参数,在忽略异常参数后将事件落盘到事件文件;
  • 返回值小于0,表示事件校验失败,不将事件落盘到事件文件。

hiAppEvent.write

write(eventName: string, eventType: EventType, keyValues: object, callback: AsyncCallback<void>): void

应用事件打点方法,将事件写入到当天的事件文件中,使用callback方式作为异步回调。

系统能力: SystemCapability.HiviewDFX.HiAppEvent

参数:

参数名 类型 必填 说明
eventName string 事件名称。
eventType EventType 事件类型。
keyValues object 事件参数。
callback AsyncCallback<void> 事件回调函数。

示例:

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}`);
});
1
2
3
4
5
6
7
8
9
10

hiAppEvent.write

write(eventName: string, eventType: EventType, keyValues: object): Promise<void>

应用事件打点方法,将事件写入到当天的事件文件中,使用Promise方式作为异步回调。

系统能力: SystemCapability.HiviewDFX.HiAppEvent

参数:

参数名 类型 必填 说明
eventName string 事件名称。
eventType EventType 事件类型。
keyValues object 事件参数。

返回值:

类型 说明
Promise<void> Promise对象,可以在其then()、catch()方法中分别对事件写入成功、写入异常的情况进行异步处理。

示例:

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}`);
    });
1
2
3
4
5
6
7
8

hiAppEvent.configure

configure(config: ConfigOption): boolean

应用事件打点配置方法,可用于配置打点开关、文件目录存储限额大小等功能。

系统能力: SystemCapability.HiviewDFX.HiAppEvent

参数:

参数名 类型 必填 说明
config ConfigOption 应用事件打点配置项对象。

返回值:

类型 说明
boolean 配置结果,true 表示配置成功,false 表示配置失败。

示例:

// 配置应用事件打点功能开关
hiAppEvent.configure({
    disable: true
});

// 配置事件文件目录存储限额大小
hiAppEvent.configure({
    maxStorage: '100M'
});
1
2
3
4
5
6
7
8
9

ConfigOption

此接口提供了应用打点的配置选项。

系统能力: SystemCapability.HiviewDFX.HiAppEvent

名称 类型 必填 说明
disable boolean 应用打点功能开关。配置值为true表示关闭打点功能,false表示不关闭打点功能。
maxStorage string 打点数据本地存储文件所在目录的配额大小,默认限额为“10M”。所在目录大小超出限额后会对目录进行清理操作,会按从旧到新的顺序逐个删除打点数据文件,直到目录大小不超出限额时停止。

EventType

事件类型枚举。

系统能力: SystemCapability.HiviewDFX.HiAppEvent

名称 说明
FAULT 1 故障类型事件。
STATISTIC 2 统计类型事件。
SECURITY 3 安全类型事件。
BEHAVIOR 4 行为类型事件。

Event

此接口提供了所有预定义事件的事件名称常量。

系统能力: SystemCapability.HiviewDFX.HiAppEvent

名称 类型 可读 可写 说明
USER_LOGIN string 用户登录事件。
USER_LOGOUT string 用户登出事件。
DISTRIBUTED_SERVICE_START string 分布式服务启动事件。

Param

此接口提供了所有预定义参数的参数名称常量。

系统能力: SystemCapability.HiviewDFX.HiAppEvent

名称 类型 可读 可写 说明
USER_ID string 用户自定义ID。
DISTRIBUTED_SERVICE_NAME string 分布式服务名称。
DISTRIBUTED_SERVICE_INSTANCE_ID string 分布式服务实例ID。