【入门到实战】OpenHarmony南向子系统开发:HiSysEvent开发指南(HiSysEvent打点配置)

OpenHarmony南向设备开发:HiSysEvent查询 HiSysEvent提供了查询接口,支持开发者设置条件查询HiSysEvent事件 阅读详情

往期鸿蒙5.0全套实战文章必看:(文中附带全栈鸿蒙5.0学习资料)


概述

功能简介

组件若有HiSysEvent事件的打点需求,则需要先定义yaml文件并在bundle.json文件中配置yaml文件的路径。OpenHarmony编译框架在编译过程中则会通过python编译脚本解析校验bundle.json文件指定的所有yaml文件。在解析校验之后,编译框架会将这些yaml文件中配置的信息汇总转换成名为hisysevent.def的json文件。最后,将此json文件打包到系统指定路径下,用作HiSysEvent事件落盘的判断依据。

基本概念

在配置HiSysEvent打点之前,开发者应了解以下基本概念:

  • 事件领域 用于标识事件所属的领域,在yaml文件中以domain为键值指定。

  • 事件名称 用于指定事件领域包含的所有事件。

  • 参数 用于定义某个事件名称包含的所有键值。

约束与限制

定义事件领域、事件名称及参数的约束与限制:

  • 每个yaml文件只能有一个事件领域,且不能与其他yaml文件中定义的事件领域重名。

  • 每个事件领域可定义零个或多个事件名称,同一个事件领域内部的事件名称不能重名。

  • 每个事件名称可定义多个参数,同一个事件名称内部的参数不能重名,每个事件名称有且只有一个名称为__BASE的参数,此参数字段组成如表1,其它自定义参数,具体字段组成如表2。 表1 __BASE参数字段说明

    字段名称描述
    type字段说明:必选字段,用来标识该事件名称的类型。
    取值范围:
    - FAULT:故障类型。
    - STATISTIC:统计类型。
    - SECURITY:安全类型。
    - BEHAVIOR:行为类型。
    level字段说明:必选字段,用来标识该事件名称的级别。
    取值范围:
    - CRITICAL:严重。
    - MINOR:一般。
    tag字段说明:可选字段,用来标识该事件名称的标签。
    定义规则:
    - 最多可同时定义5个标签,标签之间使用空格来分隔。
    - 单个标签最多包含16个字符,字符范围[a-zA-Z0-9]。
    desc字段说明:必选字段,用来对该事件名称进行描述。
    定义规则:
    - 至少包含3个字符,最多包含128个字符。
    preserve字段说明:可选字段,用来标识事件是否需要落盘,默认值为true。
    取值范围:
    - true:事件需要落盘。
    - false:事件不需要落盘。

    表2 自定义参数字段说明

    字段名称描述
    type字段说明:必选字段,用来标识该参数的类型。
    取值范围:
    - BOOL
    - INT8
    - UINT8
    - INT16
    - UINT16
    - INT32
    - UINT32
    - INT64
    - UINT64
    - FLOAT
    - DOUBLE
    - STRING
    arrsize字段作用:可选字段,用来标识数组类型参数的长度。
    取值范围:
    - 1~100
    desc字段作用:必选字段,用来对该参数进行描述。
    定义规则:
    - 至少包含3个字符,最多包含128个字符。

开发步骤

编写yaml文件

编写规则

  • 事件领域命名规则:

    • 字母开头,且只能由大写字母/数字/下划线组成;
    • 字符串长度取值范围为1~16。
  • 事件名称命名规则:

    • 字母开头,且只能由大写字母/数字/下划线组成;
    • 字符串长度取值范围1~32;
    • 单个事件领域内部事件名称的不能超过4096个。
  • 参数命名规则:

    • 字母开头,且只能由大写字母/数字/下划线组成;
    • 字符串长度取值范围1~48;
    • 单个事件名称内包含的参数的个数不能超过128个。

编写样例

  • yaml文件样例指定的事件领域名称为MODULEA,该事件领域包含两个事件,名称分别是EVENT_NAMEA和EVENT_NAMEB。

  • EVENT_NAMEA被定义成错误类型的严重事件,该事件包含类型为字符串类型的NAME1参数、字符串类型的NAME2参数及无符号短整型类型的NAME3参数,可以通过事件领域MODULEA和事件名称EVENT_NAMEA对其进行实时订阅。

  • EVENT_NAMEB被定义成统计类型的一般事件,EVENT_NAMEB包含类型为无符号短整型类型的NAME1参数及整型类型的NAME2参数。因为EVENT_NAMEB在__BASE参数中定义了名称为tag1和tag2的两个事件标签,所以不仅可以通过事件领域MODULEA和事件名称EVENT_NAMEB对其进行实时订阅,所以还可以通过事件标签对该事件进行实时订阅。

    ##########################################
    # the hisysevent definition for module a #
    ##########################################
    
    domain: MODULEA
    
    EVENT_NAMEA:
        __BASE: {type: FAULT, level: CRITICAL, desc: event name a}
        NAME1: {type: STRING, desc: name1}
        NAME2: {type: STRING, desc: name2}
        NAME3: {type: UINT16, desc: name3}
    
    EVENT_NAMEB:
        __BASE: {type: STATISTIC, level: MINOR, tag: tag1 tag2, desc: event name b}
        NAME1: {type: UINT16, desc: name1}
        NAME2: {type: INT32, desc: name2}
    

验证yaml文件

配置yaml文件路径

在bundle.json文件中通过hisysevent_config属性完成yaml文件的路径指定:

{
    "name": "@ohos/moduel_a",
    "description": "module a",
    "version": "3.1",
    "license": "Apache License 2.0",
    "publishAs": "code-segment",
    "segment": {
        "destPath": "moduel_a_path"
    },
    "dirs": {},
    "scripts": {},
    "component": {
        "name": "hisysevent_native",
        "subsystem": "hiviewdfx",
        "adapted_system_type": [
            "standard"
        ],
        "rom": "",
        "ram": "",
        "hisysevent_config": [
            "//moduel_a_path/yaml_file1.yaml",
            "//moduel_a_path/yaml_file2.yaml"
        ],
        "deps": {
            "components": [
                "hilog_native",
                "hitrace_native",
                "ipc",
                "safwk",
                "samgr",
                "utils_base"
            ],
            "third_party": []
        },
        "build": {
        }
    }
}

icon-note.gif

 说明: yaml文件可根据实际需求置于组件工程的任意目录下,只要在bundle.json文件指定即可。

编译yaml文件

  • 全量编译:

    • 全量编译整个系统,会将所有组件配置的yaml文件中的配置进行汇总,正常完成系统编译后,指定目录下就会生成hisysevent.def文件。

      cd 工程根目录的绝对路径
      ./build --product-name <product name>
      
    • 全量编译生成的hisysevent.def文件可以通过以下命令获取:

      cd 工程根目录的绝对路径
      find out -name hisysevent.def -type f
      
  • 单文件编译: 也可以只编译单个组件的yaml文件,命令如下:

    cd 工程根目录的绝对路径
    ./build/ohos/hisysevent/gen_def_from_all_yaml.py --yaml-list <yaml file list> --def-path <file store directory>
    

    表3 单文件编译参数说明

    选项名称描述
    –yaml-list指定需要编译的yaml文件路径列表,多个yaml文件路径之间用空格分隔。
    –def-path指定编译生成的hisysevent.def文件的生成路径。

打点及查询定义的事件

  1. 通过hdc_std工具将hisysevent.def文件推送到至设备的//system/etc/hiview/目录下。

  2. 触发yaml文件自定义的HiSysEvent事件完成打点,通过“hisysevent -l”命令查询历史HiSysEvent事件,确认触发的自定义HiSysEvent事件是否打点成功。

鸿蒙OpenHarmony【HiSysEvent打点配置】子系统DFX HiSysEvent是面向OpenHarmony系统开发者提供的系统打点功能,通过在关键路径埋点来记录系统在运行过程中的重要信息,辅助开发者定位问题,此外还支持开发者将打点数据上传到云进行大数据质量度量。 阅读详情

相关推荐

OpenHarmony南向设备开发:HiSysEvent工具使用

目前在系统的/system/bin目录下预置了hisysevent工具,开发者可以通过此工具实时订阅HiSysEvent事件及查询历史HiSysEvent事件。

初一十五的博客 1094

【入门到实战】OpenHarmony南向子系统开发:HiSysEvent开发指南(HiSysEvent打点)

HiSysEvent打点提供了事件打点功能......

Androidbye的博客 979

OpenHarmony南向设备开发:HiSysEvent打点

提供了事件打点的相关接口能力,支持对打点事件进行落盘......

初一十五的博客 803

OpenHarmony子系统开发 - DFX(五),HiSysEvent概述,打点,打点配置

组件若有HiSysEvent事件的打点需求,则需要先定义yaml文件并在bundle.json文件中配置yaml文件的路径。OpenHarmony编译框架在编译过程中则会通过python编译脚本解析校验bundle.json文件指定的所有yaml文件。在解析校验之后,编译框架会将这些yaml文件中配置的信息汇总转换成名为hisysevent.zip文件。最后,将此zip文件打包到系统指定路径下,用作HiSysEvent事件落盘的判断依据。通过hdc_std工具。

__Benco的博客 1368

OpenHarmony南向设备开发:HiSysEvent打点配置

提供了事件打点配置的相关能力,支持在yaml文件中对打点事件进行定义.......

初一十五的博客 1072

OpenHarmony南向设备开发:HiSysEvent订阅

提供了事件订阅的相关接口能力,支持根据事件领域和事件名称来对打点事件进行订阅。

初一十五的博客 962

【入门到实战】OpenHarmony南向子系统开发:HiSysEvent订阅

HiSysEvent提供了跨进程订阅机制......

Androidbye的博客 982

鸿蒙OpenHarmony【HiSysEvent打点】子系统DFX

HiSysEvent打点提供了事件打点功能,开发者可以通过在关键路径打点来记录系统在运行过程中的重要信息。

woshishei9527的博客 733

OpenHarmony HiSysEvent打点调用实践(L2)

设备开发,通常的问题分析主要靠日志记录,OpenHarmony的日志记录分很多种,我们用的最多的是Hilog。此文章以OpenHarmony 3.1代码基础,介绍另外一种记录: 事件打点(HiSysEvent)。打点源码分析打点在代码中应用打点测试工程的编译配置打点测试操作步骤本用例开发板(3516开发板:HiSpark_AI_Hi3516D_One_Light_VER.B开发板上测试)需要全量编译,才能将的打点格式编译到hisysevent.def中去。

qq_32605779的博客 1150

鸿蒙OpenHarmony【HiSysEvent订阅】子系统DFX

HiSysEvent提供了跨进程订阅机制,开发者可以通过注册订阅接口实时获取关注的事件,例如电池模块订阅功耗相关的事件,用于分析耗电情况。

woshishei9527的博客 1173

OpenHarmony南向设备开发:Hiview开发

Hiview是一个跨平台的终端设备维测服务集,由插件管理平台和基于平台上运行的服务插件来构成整套系统。

初一十五的博客 945

【入门到实战】OpenHarmony南向子系统开发:Hiview开发指南

Hiview是一个跨平台的终端设备维测服务集.......

Androidbye的博客 990

鸿蒙OpenHarmony【Hiview开发指导】子系统DFX

Hiview是一个跨平台的终端设备维测服务集,由插件管理平台和基于平台上运行的服务插件来构成整套系统。Hiview维测服务是由HiSysEvent事件驱动的,其核心为分布在系统各处的HiSysEvent桩点,格式化的事件会通过HiSysEvent打点API上报至Hiview进行处理,其处理流程如下图所示:

woshishei9527的博客 1240

OpenHarmony子系统开发 - DFX(六),HiSysEvent订阅,查询,工具

HiSysEvent提供了查询接口,支持开发者设置条件查询HiSysEvent事件,例如功耗部件可以通过该接口获取所需的系统事件进行业务分析。目前在系统的/system/bin目录下预置了hisysevent工具,开发者可以通过此工具实时订阅HiSysEvent事件及查询历史HiSysEvent事件。

__Benco的博客 1200

OpenHarmony源码解析(12): hisysevent

表1EventType事件类型枚举事件类型描述FAULT故障类型事件。STATISTIC统计类型事件。SECURITY安全类型事件。BEHAVIOR行为类型事件。这部分因为官方文档已经讲解比较详细了,不再细讲。参考docs/zh-cn/device-dev/subsystems/subsys-dfx-hisysevent-logging.md。

myxuan475的专栏 1367

PX4无人机实战:手把手教你用MAVROS实现Offboard模式(附避坑指南)

本文提供了一份详尽的PX4无人机Offboard模式实战指南,重点解析了如何通过MAVROS实现从仿真到实机的控制。内容涵盖硬件连接、串口权限设置、MAVROS配置、核心代码编写以及实机操作全流程,并附有详细的避坑指南和故障排查手册,帮助开发者快速掌握ROS与PX4飞控的集成开发。

weixin_29172201的博客 270

OpenHarmony子系统开发 - DFX(九),Hiview开发指导

当开发者需要对事件源分发过来的HiSysEvent事件进行特定业务处理的时候,需要在Hiview平台上新增一个插件,并借助该插件进行相应业务处理,下文将具体介绍如何进行Hiview插件开发。

__Benco的博客 1348

用Java实现森林冰火人游戏

g.drawString("游戏结束", CELL_SIZE * COLS / 2 - 100, CELL_SIZE * ROWS / 2);g.drawString("难度级别: " + difficultyLevel, 10, CELL_SIZE * ROWS + 60);g.drawString("生命值: " + playerHealth, 10, CELL_SIZE * ROWS + 20);setTitle("森林冰火人");

2401_82778412的博客 1736

OpenHarmony DFX子系统

在OpenHarmony中,DFX()是为了提升质量属性软件设计,目前包含的内容主要有:DFR(Design for Reliability,可靠性)和DFT(Design for Testability,可测试性)特性。提供以下功能:HiLog流水日志。HiView插件平台。FaultLoggerd应用故障收集和订阅。HiAppEvent应用事件记录接口及框架。HiSysEvent系统事件记录接口及服务。

__Benco的博客 654

CMap与L1000技术解析:基因表达数据在药物发现中的应用

本文深入解析了CMap(连接图)与L1000技术在药物发现中的核心应用。CMap通过构建基因表达“关系网”,实现基于模式匹配的药物重定位;L1000技术则以低成本、高通量方式生成关键基因表达数据,支撑了LINCS超级数据库。文章以CLUE平台为例,手把手演示了如何利用疾病基因表达签名逆向筛选潜在治疗化合物,并拓展了其在解析药物机制、预测副作用等多场景下的价值。

weixin_29207533的博客 728

ESP32-P4开发板实战:从零配置VSCode环境到点亮MIPI-DSI屏幕(避坑指南)

本文详细介绍了ESP32-P4开发板在VSCode环境下的配置流程,包括SDK安装、idf_component.yml依赖管理,以及MIPI-DSI屏幕驱动的实现方法。通过实战指南帮助开发者避开常见配置陷阱,快速完成从环境搭建到屏幕点亮的全流程,适用于物联网和嵌入式开发场景。

pp12345的博客 748

别只盯着DevTools了!用OpenHarmony的HiSysEvent给你的Flutter应用做一次“线上体检”

本文探讨了如何利用OpenHarmony的HiSysEvent系统为Flutter应用构建线上性能监控体系,解决传统DevTools在真实用户场景中的局限性。通过全生命周期覆盖、低性能损耗和多维度关联等优势,HiSysEvent能够有效捕捉设备碎片化和特定环境导致的性能问题,助力开发者实现从开发到线上的全链路可观测性。

weixin_42697475的博客 328

Coze智能体开发:扣子智能体设置多Agent模式

在扣子中创建智能体后,智能体默认使用单 Agent 模式。在单 Agent 模式下处理复杂任务时,你必须编写非常详细和冗长的提示词,而且你可能需要添加各种插件和工作流等,这增加了调试智能体的复杂性。调试时任何一处细节改动,都有可能影响到智能体的整体功能,实际处理用户任务时,处理结果可能与预期效果有较大出入。

王国平的博客 3715
上一篇: 【入门到实战】OpenHarmony南向子系统开发:HiCollie开发指南
下一篇: 【入门到实战】OpenHarmony南向子系统开发:HiSysEvent开发指南(HiSysEvent打点)
懂你的大海
博客等级 码龄6年 9049粉丝 1381原创
评论
成就一亿技术人!
拼手气红包6.0元
还能输入1000个字符
 
 条评论被折叠 查看
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付:10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值