0
  • 聊天消息
  • 系统消息
  • 评论与回复
登录后你可以
  • 下载海量资料
  • 学习在线课程
  • 观看技术视频
  • 写文章/发帖/加入社区
会员中心
创作中心

完善资料让更多小伙伴认识你,还能领取20积分哦,立即完善>

3天内不再提示

鸿蒙开发系统基础能力:ohos.hiAppEvent应用打点

jf_46214456 来源:jf_46214456 作者:jf_46214456 2024-06-24 11:09 次阅读

应用打点

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

icon-note.gif说明: 本模块首批接口从API version 7开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。 开发前请熟悉鸿蒙开发指导文档 :[gitee.com/li-shizhen-skin/harmony-os/blob/master/README.md]

导入模块

import hiAppEvent from '@ohos.hiAppEvent';

hiAppEvent.write

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

应用事件打点方法,将事件写入到当天的事件文件中,可接收类型为Json对象的事件参数,使用callback方式作为异步回调。

系统能力: SystemCapability.HiviewDFX.HiAppEvent

参数:

参数名类型必填说明
eventNamestring应用事件名称。 由开发者自定义。事件名称在48个字符以内,有效的字符是0-9、a-z、下划线,只能以字母开头。
eventType[EventType]应用事件类型。
keyValuesobject事件参数键值对,如果是变长参数类型,则依次输入事件的参数名与参数值。如果是Json对象类型,则Json对象的key是事件的参数名,value是事件的参数值。 - key类型只能为string,value类型只能为string、number、boolean、Array(数组数据类型只能为string、number、boolean)。 - 事件的参数个数必须小于等于32。 - 参数名在16个字符以内,有效的字符是0-9、a-z、下划线,只能以字母开头,不能以下划线结尾。 - string类型参数值在8*1024个字符内。 - Array类型参数值的元素个数必须在100个以内,超出时会进行截断处理。
callbackAsyncCallback回调函数,可以在回调函数中处理接口返回值。 - 返回值为0表示事件校验成功,事件正常异步写入事件文件; - 大于0表示事件校验存在异常参数,在忽略异常参数后将事件异步写入事件文件; - 小于0表示事件校验失败,不将事件写入事件文件。

示例:

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}`);
});

hiAppEvent.write

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

应用事件打点方法,将事件写入到当天的事件文件中,可接收类型为Json对象的事件参数,使用promise方式作为异步回调。

系统能力: SystemCapability.HiviewDFX.HiAppEvent

参数:

参数名类型必填说明
eventNamestring应用事件名称。 由开发者自定义。事件名称在48个字符以内,有效的字符是0-9、a-z、下划线,只能以字母开头。
eventType[EventType]应用事件类型。
keyValuesobject事件参数键值对,如果是变长参数类型,则依次输入事件的参数名与参数值。如果是Json对象类型,则Json对象的key是事件的参数名,value是事件的参数值。 - key类型只能为string,value类型只能为string、number、boolean、Array(数组数据类型只能为string、number、boolean)。 - 事件的参数个数必须小于等于32。 - 参数名在16个字符以内,有效的字符是0-9、a-z、下划线,只能以字母开头,不能以下划线结尾。 - string类型参数值在8*1024个字符内。 - Array类型参数值的元素个数必须在100个以内,超出时会进行截断处理。

返回值:

类型说明
PromisePromise实例,可以在其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}`);
    });

hiAppEvent.configure

configure(config: ConfigOption): boolean

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

系统能力: SystemCapability.HiviewDFX.HiAppEvent

参数:

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

返回值:

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

示例:

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

// 配置事件文件目录存储限额大小
hiAppEvent.configure({
    maxStorage: '100M'
});

ConfigOption

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

系统能力: 以下各项对应的系统能力均为SystemCapability.HiviewDFX.HiAppEvent。

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

EventType

事件类型枚举。

系统能力: 以下各项对应的系统能力均为SystemCapability.HiviewDFX.HiAppEvent。

名称默认值说明
FAULT1故障类型事件。
STATISTIC2统计类型事件。
SECURITY3安全类型事件。
BEHAVIOR4行为类型事件。

Event

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

系统能力: 以下各项对应的系统能力均为SystemCapability.HiviewDFX.HiAppEvent。

名称参数类型可读可写说明
USER_LOGINstring用户登录事件。
USER_LOGOUTstring用户登出事件。
DISTRIBUTED_SERVICE_STARTstring分布式服务启动事件。HarmonyOSOpenHarmony鸿蒙文档籽料:mau123789是v直接拿

搜狗高速浏览器截图20240326151547.png

Param

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

系统能力: 以下各项对应的系统能力均为SystemCapability.HiviewDFX.HiAppEvent。

名称参数类型可读可写说明
USER_IDstring用户自定义ID。
DISTRIBUTED_SERVICE_NAMEstring分布式服务名称。
DISTRIBUTED_SERVICE_INSTANCE_IDstring分布式服务实例ID。
声明:本文内容及配图由入驻作者撰写或者入驻合作网站授权转载。文章观点仅代表作者本人,不代表电子发烧友网立场。文章及其配图仅供工程师学习之用,如有内容侵权或者其他违规问题,请联系本站处理。 举报投诉
  • 开发系统
    +关注

    关注

    0

    文章

    38

    浏览量

    9679
  • 鸿蒙
    +关注

    关注

    57

    文章

    2348

    浏览量

    42831
收藏 人收藏

    评论

    相关推荐

    HarmonyOS应用事件打点开发指导

    信息。 HiAppEvent 是在系统层面为应用开发者提供的一种事件打点机制,用于帮助应用记录在运行过程中发生的故障信息、统计信息、安全信息、用户行为信息,以支撑
    发表于 12-21 11:02

    鸿蒙实战项目开发:【短信服务】

    岗位需要掌握那些核心技术点?为此鸿蒙开发学习必须要系统性的进行。 而网上有关鸿蒙开发资料非常的少,假如你想学好
    发表于 03-03 21:29

    鸿蒙原生应用/元服务开发-Stage模型能力接口(一)

    @ohos.app.ability.Ability (Ability基类)一、说明 UIAbility和ExtensionAbility的基类,提供系统配置更新回调和系统内存调整回调。本模块首批接口
    发表于 12-08 16:34

    鸿蒙原生应用/元服务开发-Stage模型能力接口(二)

    系统能力:以下各项对应的系统能力均为SystemCapability.Ability.AbilityRuntime.Core2.AbilityConstant.LaunchReas
    发表于 12-11 14:48

    鸿蒙原生应用/元服务开发-Stage模型能力接口(四)

    ‘@ohos.app.ability.AbilityStage’; 1.AbilityStage.onCreate onCreate(): void 当应用创建时调用。 系统能力
    发表于 12-14 15:39

    鸿蒙原生应用/元服务开发-Stage模型能力接口(五)

    在Stage模型下使用 二、 导入模块 import common from \'@ohos.app.ability.common\'; 三、系统能力 :以下各项对应的系统
    发表于 12-15 15:11

    鸿蒙原生应用/元服务开发-Stage模型能力接口(七)

    下文ApplicationContext对系统环境变化监听回调的能力,包括onConfigurationUpdated方法。本模块首批接口从API version 9 开始支持。后续版本的新增接口,采用上角标单独标记
    发表于 12-19 11:03

    鸿蒙原生应用/元服务开发-Stage模型能力接口(八)

    ‘@ohos.app.ability.ExtensionAbility’; 系统能力:SystemCapability.Ability.AbilityRuntime.AbilityCore 示例: class MyExtens
    发表于 12-20 16:12

    鸿蒙系统是基于什么开发

    争议,那么鸿蒙系统到底是基于什么开发的呢?下面小编就为大家带来鸿蒙系统是基于什么开发的答案。
    的头像 发表于 07-05 17:12 1.2w次阅读

    鸿蒙OS开发实例:【应用事件打点

    HiAppEvent是在系统层面为应用开发者提供的一种事件打点机制,用于帮助应用记录在运行过程中发生的故障信息、统计信息、安全信息、用户行为信息,以支撑
    的头像 发表于 04-07 17:13 478次阅读
    <b class='flag-5'>鸿蒙</b>OS<b class='flag-5'>开发</b>实例:【应用事件<b class='flag-5'>打点</b>】

    鸿蒙开发系统基础能力ohos.hilog 日志打印

    hilog日志系统,使应用/服务可以按照指定级别、标识和格式字符串输出日志内容,帮助开发者了解应用/服务的运行状态,更好地调试程序。
    的头像 发表于 06-25 15:59 446次阅读

    鸿蒙开发系统基础能力ohos.hiTraceChain 分布式跟踪

    本模块提供了端侧业务流程调用链跟踪的打点能力,包括业务流程跟踪的启动、结束、信息埋点等能力
    的头像 发表于 06-25 09:49 329次阅读
    <b class='flag-5'>鸿蒙</b><b class='flag-5'>开发</b><b class='flag-5'>系统</b>基础<b class='flag-5'>能力</b>:<b class='flag-5'>ohos</b>.hiTraceChain 分布式跟踪

    鸿蒙开发系统基础能力ohos.hiTraceMeter性能打点

    本模块提供了追踪进程轨迹,度量程序执行性能的打点能力。本模块打点的数据供hiTraceMeter工具分析使用。
    的头像 发表于 06-25 16:12 399次阅读
    <b class='flag-5'>鸿蒙</b><b class='flag-5'>开发</b><b class='flag-5'>系统</b>基础<b class='flag-5'>能力</b>:<b class='flag-5'>ohos</b>.hiTraceMeter性能<b class='flag-5'>打点</b>

    鸿蒙开发系统基础能力ohos.pasteboard 剪贴板

    以下各项对应的系统能力均为SystemCapability.MiscServices.Pasteboard。
    的头像 发表于 06-26 16:48 411次阅读
    <b class='flag-5'>鸿蒙</b><b class='flag-5'>开发</b><b class='flag-5'>系统</b>基础<b class='flag-5'>能力</b>:<b class='flag-5'>ohos</b>.pasteboard 剪贴板

    鸿蒙开发系统基础能力ohos.screenLock 锁屏管理

    锁屏管理服务是OpenHarmony中系统服务,为锁屏应用提供注册亮屏、灭屏、开启屏幕、结束休眠、退出动画、请求解锁结果监听,并提供回调结果给锁屏应用。锁屏管理服务向三方应用提供请求解锁、查询锁屏状态、查询是否设置锁屏密码的能力
    的头像 发表于 06-27 11:41 707次阅读
    <b class='flag-5'>鸿蒙</b><b class='flag-5'>开发</b><b class='flag-5'>系统</b>基础<b class='flag-5'>能力</b>:<b class='flag-5'>ohos</b>.screenLock 锁屏管理