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

OpenHarmony南向设备开发:HiSysEvent打点 提供了事件打点的相关接口能力,支持对打点事件进行落盘...... 阅读详情

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


概述

功能简介

HiSysEvent打点提供了事件打点功能,开发者可以通过在关键路径打点来记录系统在运行过程中的重要信息。同时,HiSysEvent打点也提供了以事件领域为单位的HiSysEvent打点屏蔽机制,方便开发者评估及调试HiSysEvent打点操作的影响。

运作机制

在进行HiSysEvent事件打点之前,需要先完成HiSysEvent打点配置。

开发指导

场景介绍

事件打点的主要工作是将打点数据进行落盘。

接口说明

C++接口说明

C++事件打点开发能力如下:HiSysEvent类,具体API详见接口目录(/base/hiviewdfx/hisysevent/interfaces/native/innerkits/hisysevent/include/)。

icon-note.gif

 说明:

从OpenHarmony-3.2-Beta3版本开始,为避免打点风暴事件引发性能问题,对HiSysEvent打点进行了管控。表1中的HiSysEvent::Write打点接口被表2中的HiSysEventWrite宏接口取代。HiSysEvent::Write接口已废弃,请使用HiSysEventWrite宏接口完成HiSysEvent事件打点。

表1 事件打点接口(已废弃)

接口名描述
template<typename… Types> 
static int Write(const std::string &domain, const std::string &eventName, EventType type, Types… keyValues)
将打点事件数据进行落盘。

表2 事件打点宏接口

接口名描述
HiSysEventWrite(domain, eventName, type, …)将打点事件数据进行落盘。

表3 EventType事件类型枚举

事件类型描述
FAULT故障类型事件。
STATISTIC统计类型事件。
SECURITY安全类型事件。
BEHAVIOR行为类型事件。
C接口说明

C事件打点开发能力如下:具体API详见接口目录(/base/hiviewdfx/hisysevent/interfaces/native/innerkits/hisysevent/include/)。

表4 事件打点接口

接口名描述
int OH_HiSysEvent_Write(const char* domain, const char* name, HiSysEventEventType type, HiSysEventParam params[], size_t size);将打点事件数据进行落盘。

表5 HiSysEventEventType事件类型枚举

事件类型描述
HISYSEVENT_FAULT故障类型事件。
HISYSEVENT_STATISTIC统计类型事件。
HISYSEVENT_SECURITY安全类型事件。
HISYSEVENT_BEHAVIOR行为类型事件。

表6 HiSysEventParam事件参数结构体

属性名称属性类型描述
namechar name[]事件参数名称。
tHiSysEventParamType事件参数类型。
vHiSysEventParamValue事件参数值。
arraySizesize_t事件参数值为数组类型时的数组长度。

表7 HiSysEventParamType事件参数类型枚举

参数类型描述
HISYSEVENT_INVALID无效类型事件参数。
HISYSEVENT_BOOLbool类型事件参数。
HISYSEVENT_INT8int8_t类型事件参数。
HISYSEVENT_UINT8uint8_t类型事件参数。
HISYSEVENT_INT16int16_t类型事件参数。
HISYSEVENT_UINT16uint16_t类型事件参数。
HISYSEVENT_INT32int32_t类型事件参数。
HISYSEVENT_UINT32uint32_t类型事件参数。
HISYSEVENT_INT64int64_t类型事件参数。
HISYSEVENT_UINT64uint64_t类型事件参数。
HISYSEVENT_FLOATfloat类型事件参数。
HISYSEVENT_DOUBLEdouble类型事件参数。
HISYSEVENT_STRINGchar*类型事件参数。
HISYSEVENT_BOOL_ARRAYbool数组类型事件参数。
HISYSEVENT_INT8_ARRAYint8_t数组类型事件参数。
HISYSEVENT_UINT8_ARRAYuint8_t数组类型事件参数。
HISYSEVENT_INT16_ARRAYint16_t数组类型事件参数。
HISYSEVENT_UINT16_ARRAYuint16_t数组类型事件参数。
HISYSEVENT_INT32_ARRAYint32_t数组类型事件参数。
HISYSEVENT_UINT32_ARRAYuint32_t数组类型事件参数。
HISYSEVENT_INT64_ARRAYint64_t数组类型事件参数。
HISYSEVENT_UINT64_ARRAYuint64_t数组类型事件参数。
HISYSEVENT_FLOAT_ARRAYfloat数组类型事件参数。
HISYSEVENT_DOUBLE_ARRAYdouble数组类型事件参数。
HISYSEVENT_STRING_ARRAYchar*数组类型事件参数。

表8 HiSysEventParamValue事件参数值联合体

属性名称属性类型描述
bboolbool类型事件参数值。
i8int8_tint8_t类型事件参数值。
ui8uint8_tuint8_t类型事件参数值。
i16int16_tint16_t类型事件参数值。
ui16uint16_tuint16_t类型事件参数值。
i32int32_tint32_t类型事件参数值。
ui32uint32_tuint32_t类型事件参数值。
i64int64_tint64_t类型事件参数值。
ui64uint64_tuint64_t类型事件参数值。
ffloatfloat类型事件参数值。
ddoubledouble类型事件参数值。
schar*char*类型事件参数值。
arrayvoid*数组类型事件参数值。
kernel接口说明

kernel事件打点开发能力如下:具体API详见接口文件(/kernel/linux/linux-5.10/include/dfx/hiview_hisysevent.h)。

表9 事件打点接口

接口名描述
struct hiview_hisysevent *hisysevent_create(const char *domain, const char *name, enum hisysevent_type type);创建一个事件对象。
void hisysevent_destroy(struct hiview_hisysevent *event);销毁一个事件对象。
int hisysevent_put_integer(struct hiview_hisysevent *event, const char *key, long long value);将整数类型的事件参数添加到事件对象。
int hisysevent_put_string(struct hiview_hisysevent *event, const char *key, const char *value);将字符串类型的事件参数添加到事件对象。
int hisysevent_write(struct hiview_hisysevent *event);将事件对象数据进行落盘。

表10 hisysevent_type事件类型枚举

事件类型描述
FAULT故障类型事件。
STATISTIC统计类型事件。
SECURITY安全类型事件。
BEHAVIOR行为类型事件。

开发步骤

C++打点开发步骤

在需要打点的地方直接调用打点接口,并传入相应事件参数。

HiSysEventWrite(HiSysEvent::Domain::AAFWK, "START_APP", HiSysEvent::EventType::BEHAVIOR, "APP_NAME", "com.ohos.demo");
C打点开发步骤
  1. 如果需要在打点时传入自定义事件参数,先要根据事件参数类型创建对应的事件参数对象,再将其放入到事件参数数组中。

    // 创建一个int32_t类型的事件参数
    HiSysEventParam param1 = {
        .name = "KEY_INT32",
        .t = HISYSEVENT_INT32,
        .v = { .i32 = 1 },
        .arraySize = 0,
    };
    
    // 创建一个int32_t数组类型的事件参数
    int32_t int32Arr[] = { 1, 2, 3 };
    HiSysEventParam param2 = {
        .name = "KEY_INT32_ARR",
        .t = HISYSEVENT_INT32_ARRAY,
        .v = { .array = int32Arr },
        .arraySize = sizeof(int32Arr) / sizeof(int32Arr[0]),
    };
    
    // 将事件参数对象放入创建的事件参数数组中
    HiSysEventParam params[] = { param1, param2 };
    
  2. 在需要打点的地方调用打点接口,并传入相应事件参数。

    OH_HiSysEvent_Write("TEST_DOMAIN", "TEST_NAME", HISYSEVENT_BEHAVIOR, params, sizeof(params) / sizeof(params[0]));
    
kernel打点开发步骤
  1. 根据事件领域、事件名称、事件类型参数,创建一个基础的事件对象。

    struct hiview_hisysevent *event = hisysevent_create("KERNEL", "BOOT", BEHAVIOR);
    
  2. 将自定义的事件参数,传入到事件对象里。

    // 添加整数类型参数
    hisysevent_put_integer(event, "BOOT_TIME", 100);
    
    // 添加字符串类型参数
    hisysevent_put_string(event, "MSG", "This is a test message");
    
  3. 在事件对象构建完成后,将事件进行上报。

    hisysevent_write(event);
    
  4. 事件上报完成后,需要手动将对象销毁。

    hisysevent_destroy(&event);
    
事件领域屏蔽的步骤
  1. 在相应的文件中定义名称为“DOMAIN_MASKS”,内容形如“DOMAIN_NAME_1|DOMAIN_NAME_2|…|DOMAIN_NAME_n”。共有三种屏蔽场景:
  • 只屏蔽当前源码文件中的相应事件领域的HiSysEvent打点,在该cpp文件引入hisysevent.h头文件之前定义宏DOMAIN_MASKS即可。

    #define DOMAIN_MASKS "DOMAIN_NAME_1|DOMAIN_NAME_2|...|DOMAIN_NAME_n"
    #include "hisysevent.h"
    
  • 屏蔽整个模块相应事件领域的HiSysEvent打点,在模块的BUILD.gn文件中定义宏DOMAIN_MASKS即可。

    config("module_a"){
      cflags_cc += ["-DDOMAIN_MASKS=\"DOMAIN_NAME_1|DOMAIN_NAME_2|...|DOMAIN_NAME_n\""]
    }
    
  • 全局屏蔽相应事件领域的HiSysEvent打点,则在/build/config/compiler/BUILD.gn中定义宏DOMAIN_MASKS即可。

      cflags_cc += ["-DDOMAIN_MASKS=\"DOMAIN_NAME_1|DOMAIN_NAME_2|...|DOMAIN_NAME_n\""]
    
  1. 通过HiSysEventWrite宏完成HiSysEvent打点操作:
    constexpr char DOMAIN[] = "DOMAIN_NAME_1";
    const std::string eventName = "EVENT_NAME1";
    OHOS:HiviewDFX::HiSysEvent::EventType eventType = OHOS:HiviewDFX::HiSysEvent::EventType::FAULT;
    HiSysEventWrite(domain, eventName, eventType); //因为DOMAIN_NAME_1事件领域已经在DOMAIN_MASKS中定义,所以该HiSysEvent打点不会执行。
    

开发实例

C++打点开发实例

假设业务模块需要在应用启动时进行打点来记录应用启动事件,且需要记录应用的包名信息,完整使用示例如下所示:

  1. 首先,需要在业务模块的在BUILD.gn里增加HiSysEvent部件依赖。

    external_deps = [ "hisysevent:libhisysevent" ]
    
  2. 在业务模块的应用启动函数StartAbility()中,调用打点接口并传入对应事件参数。

    #include "hisysevent.h"
    
    int StartAbility()
    {
        ... // 其他业务逻辑
        int ret = HiSysEventWrite(HiSysEvent::Domain::AAFWK, "START_APP", HiSysEvent::EventType::BEHAVIOR, "APP_NAME", "com.ohos.demo");
        ... // 其他业务逻辑
    }
    
C打点开发实例

假设业务模块需要在应用启动时进行打点来记录应用启动事件,且需要记录应用的包名信息,完整使用示例如下所示:

  1. 首先,需要在业务模块的在BUILD.gn里增加HiSysEvent部件依赖。

    external_deps = [ "hisysevent:libhisysevent" ]
    
  2. 在业务模块的应用启动函数StartAbility()中,调用打点接口并传入对应事件参数。

    #include "hisysevent_c.h"
    
    int StartAbility()
    {
        ... // 其他业务逻辑
        char packageName[] = "com.ohos.demo";
        HiSysEventParam param = {
            .name = "APP_NAME",
            .t = HISYSEVENT_STRING,
            .v = { .s = packageName },
            .arraySize = 0,
        };
        HiSysEventParam params[] = { param };
        int ret = OH_HiSysEvent_Write("AAFWK", "START_APP", HISYSEVENT_BEHAVIOR, params, sizeof(params) / sizeof(params[0]));
        ... // 其他业务逻辑
    }
    
kernel打点开发实例

假设内核业务模块需要在设备启动时进行打点来记录设备启动事件,完整使用示例如下所示:

  1. 在设备启动函数device_boot()中,构建一个启动事件对象,然后将事件进行上报,最后销毁事件对象。

    #include <dfx/hiview_hisysevent.h>
    
    #include <linux/errno.h>
    #include <linux/printk.h>
    
    int device_boot()
    {
        ... // 其他业务逻辑
        struct hiview_hisysevent *event = NULL;
        int ret = 0;
    
        event = hisysevent_create("KERNEL", "BOOT", BEHAVIOR);
        if (!event) {
            pr_err("failed to create event");
            return -EINVAL;
        }
        ret = hisysevent_put_string(event, "MSG", "This is a test message");
        if (ret != 0) {
            pr_err("failed to put sting to event, ret=%d", ret);
            goto hisysevent_end;
        }
        ret = hisysevent_write(event);
    
    hisysevent_end:
        hisysevent_destroy(&event);
        ... // 其他业务逻辑
    }
    
事件领域屏蔽的开发实例
  • 假设业务模块中,需要在某个cpp文件中屏蔽名称分别为AAFWK和POWER的事件领域的打点,在该cpp文件引入hisysevent.h头文件之前,定义名称为DOMAIN_MASKS的宏:

    #define DOMAIN_MASKS "AAFWK|POWER"
    
    #include "hisysevent.h"
    ... // 其他业务逻辑
    HiSysEventWrite(OHOS:HiviewDFX::HiSysEvent::Domain::AAFWK, "JS_ERROR", OHOS:HiviewDFX::HiSysEvent::EventType::FAULT, "MODULE", "com.ohos.module"); // 该HiSysEvent打点操作不会执行
    ... // 其他业务逻辑
    HiSysEventWrite(OHOS:HiviewDFX::HiSysEvent::Domain::POWER, "POWER_RUNNINGLOCK", OHOS:HiviewDFX::HiSysEvent::EventType::FAULT, "NAME", "com.ohos.module"); // 该HiSysEvent打点操作不会执行
    
  • 假设需要在整个业务模块中屏蔽名称分别为AAFWK和POWER的事件领域的打点,在模块的BUILG.gn文件中定义名称为DOMAIN_MASKS的宏:

    config("module_a") {
        ... // 其他配置项
        cflags_cc += ["-DDOMAIN_MASKS=\"AAFWK|POWER\""]
    }
    
  • 假设需要在整个系统中屏蔽名称分别为AAFWK和POWER的事件领域的打点,则直接在/build/config/compiler/BUILD.gn文件中定义名称为DOMAIN_MASKS的宏:

    ... // 其他配置项
    cflags_cc += ["-DDOMAIN_MASKS=\"AAFWK|POWER\""]

OpenHarmony南向设备开发:HiSysEvent工具使用 目前在系统的/system/bin目录下预置了hisysevent工具,开发者可以通过此工具实时订阅HiSysEvent事件及查询历史HiSysEvent事件。 阅读详情

相关推荐

OpenHarmony南向设备开发:HiSysEvent查询

HiSysEvent提供了查询接口,支持开发者设置条件查询HiSysEvent事件

初一十五的博客 977

HarmonyOS 鸿蒙DFX能力简介

Development and Feedback eXchange(‌DFX)‌,‌用于开发、‌测试和维护鸿蒙应用,提供一系列的工具和功能,‌帮助开发者在开发过程中进行性能分析、‌故障检测、‌异常处理。比如异常处理、性能分析、全场景软总线。应用异常Crash日志规格:设备信息 软件版本 模块信息 应用基础信息 崩溃故障信息。能够识别不同类型异常,统一保存和恢复数据,体现到重启恢复。

MuZiChunChun的博客 1591

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

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

woshishei9527的博客 968

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

OpenHarmony编译框架在编译过程中则会通过python编译脚本解析校验bundle.json文件指定的所有yaml文件。

Androidbye的博客 729

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

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

woshishei9527的博客 733

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

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

woshishei9527的博客 1173

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

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

__Benco的博客 1368

鸿蒙OpenHarmony【HiSysEvent工具使用】子系统DFX

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

woshishei9527的博客 797

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

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

Androidbye的博客 982

鸿蒙OpenHarmony【HiSysEvent查询】子系统DFX

HiSysEvent提供了查询接口,支持开发者设置条件查询HiSysEvent事件,例如功耗部件可以通过该接口获取所需的系统事件进行业务分析。

woshishei9527的博客 1167

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

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

woshishei9527的博客 1240

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

HiSysEvent提供了查询接口......

Androidbye的博客 762

OpenHarmony源码解析(12): hisysevent

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

myxuan475的专栏 1367

【入门到实战】OpenHarmony南向子系统开发:HiSysEvent工具使用

目前在系统的/system/bin目录下预置了hisysevent工具.......

Androidbye的博客 1092

MineMap开发教程: 北斗网格位置码实时调度技术详解

本文介绍了MineMap4.0引擎中北斗网格位置码的实时调度技术。北斗网格位置码是我国自主研发的空间位置编码标准,具有层次化结构、三维编码等特点。MineMap4.0通过BeiDouGrid类实现了高效的实时调度机制,重点展示了按预想高度进行网格调度的核心功能。关键技术包括视锥体裁剪、LOD控制、高度筛选算法和交互式查询等。该技术在智慧城市、环境监测等领域具有广泛应用前景,凭借高性能、高精度等优势,为三维地理信息可视化提供了有力支撑。

weixin_42568040的博客 1465

BU61580芯片实战:手把手教你配置1553B通信的BC端寄存器(含代码解析)

本文详细解析了BU61580芯片在1553B通信中的BC端寄存器配置方法,包括关键寄存器功能映射、初始化代码解析及回环测试实现。通过实战案例和代码示例,帮助开发者快速掌握1553B通信的核心技术,提升系统稳定性和通信质量。

a1b2c的博客 227

OpenHarmony HiSysEvent打点调用实践(L2)

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

qq_32605779的博客 1150

高德地图与CAD图叠加显示方法汇总及优缺点分析

高德地图应用在许多领域,平常我们用的地图导航,除过正常的地图导航指引功能之外,其实还有很多实用的功能。如高德影像地图应用在包括地理、土地测量、水文学、生态学、气象学以及海洋学等方面。AutoCAD在行业中常用于城市规划、平面设计、建筑师等,这其中也要用到高德地图。最常见的是CAD图与高德地图叠加使用,通过两者叠加直观显示,助力行业提高工作效率。那如何将高德地图与CAD图叠加显示呢?下面听小编把方法一一介绍下以及各种方法的优缺点。

vjmap的博客 2728

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

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

Androidbye的博客 990

风力发电机并网模型建立及仿真验证

传统能源日益匮乏,环境污染日趋严重,全球向安全、可靠和环保的可持续能源体系转型迫在眉睫,风电迎来了重要的发展契机。近年来,全球风电迅猛发展,我国已成为世界风电新增装机容量第一的国家。然而,随着风电规模的不断增大,风电场接入对系统影响不容忽视。随着变速恒频风力发电系统优越的性能突出和大容量电力电子技术的成熟,风速随机性引起的功率波动及故障情况下的动态响应,对电能质量,系统电压、频率的稳定性产生的影响需要深入研究。因而,本文结合实际项目,针对变速恒频风力发电系统建模,端口动态特性及对电网电能质量、运行稳定性的影

毕业设计区博客 1647

初识数据结构之入门必懂——线性表(顺序表)

本文将介绍数据结构中的线性表与线性表中最简单的结构——顺序表

m0_64705485的博客 905

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

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

__Benco的博客 1200

手把手教你用C语言给STM32写一个Modbus RTU从机库(含完整项目源码)

在工业自动化领域,Modbus RTU协议因其简单可靠的特点,成为RS485总线通信的事实标准。对于嵌入式开发者而言,为STM32等微控制器实现一个高效的Modbus RTU从机协议栈,是开发智能传感器、执行器等设备的必备技能。Modbus RTU从机的核心是一个状态机,需要处理帧接收、CRC校验、功能码解析和响应生成等环节。工业现场总会遇到意想不到的干扰情况,一个健壮的协议栈应该能够优雅地处理各种异常场景,而不是简单地崩溃或死锁。工业现场环境复杂,协议栈必须具备完善的异常处理机制。

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

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明:

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

余额充值