diff --git a/zh-cn/device-dev/subsystems/Readme-CN.md b/zh-cn/device-dev/subsystems/Readme-CN.md index d18d16d5b17f97a384be84f2fc93cf6aaf7cb810..415a5ba5a361ba58b390016a5f163d77e359bc66 100755 --- a/zh-cn/device-dev/subsystems/Readme-CN.md +++ b/zh-cn/device-dev/subsystems/Readme-CN.md @@ -81,9 +81,10 @@ - [HiTrace开发指导](subsys-dfx-hitrace.md) - [HiCollie开发指导](subsys-dfx-hicollie.md) - [HiSysEvent开发指导](subsys-dfx-hisysevent.md) - - [HiSysEvent打点指导](subsys-dfx-hisysevent-write.md) - - [HiSysEvent订阅指导](subsys-dfx-hisysevent-read.md) - - [HiSysEvent查询指导](subsys-dfx-hisysevent-select.md) + - [HiSysEvent打点配置指导](subsys-dfx-hisysevent-logging-config.md) + - [HiSysEvent打点指导](subsys-dfx-hisysevent-logging.md) + - [HiSysEvent订阅指导](subsys-dfx-hisysevent-listening.md) + - [HiSysEvent查询指导](subsys-dfx-hisysevent-querying.md) - [HiSysEvent工具使用指导](subsys-dfx-hisysevent-tool.md) - [研发工具链](subsys-toolchain.md) - [bytrace使用指导](subsys-toolchain-bytrace-guide.md) diff --git a/zh-cn/device-dev/subsystems/subsys-dfx-hisysevent-listening.md b/zh-cn/device-dev/subsystems/subsys-dfx-hisysevent-listening.md index 716bdfc479b1d1a161354fd8b1a5c2c0bf8108be..b8d97a3c403de045298a05cd965f3bb355a4c5ed 100644 --- a/zh-cn/device-dev/subsystems/subsys-dfx-hisysevent-listening.md +++ b/zh-cn/device-dev/subsystems/subsys-dfx-hisysevent-listening.md @@ -2,7 +2,7 @@ - [概述](#section315316685112) - [功能简介](#section123181433335224) - - [约束与限制](#section123181433375224) + - [约束与限制](#section123181433375224) - [开发指导](#section315316685113) - [接口说明](#section0342191810519) - [开发实例](#section123181432175110) @@ -17,7 +17,7 @@ HiSysEvent提供了跨进程订阅机制，开发者可以通过注册订阅接 **HiSysEvent事件订阅条件约束：** -- 在订阅HiSysEvent事件之前，需要先完成HiSysEvent打点配置，具体配置方法请参考[《HiSysEvent打点配置指导》](subsys-dfx-hisysevent-write-config.md)。 +- 在订阅HiSysEvent事件之前，需要先完成HiSysEvent打点配置，具体配置方法请参考[《HiSysEvent打点配置指导》](subsys-dfx-hisysevent-logging-config.md)。 ## 开发指导 @@ -25,74 +25,18 @@ HiSysEvent提供了跨进程订阅机制，开发者可以通过注册订阅接 **表 1** HiSysEvent订阅接口 - - - - - - - - - - - - -

接口名称

-

描述

-

int HiSysEventManager::AddEventListener(std::shared_ptr<HiSysEventSubscribeCallBackBase> listener, std::vector<ListenerRule>& rules)

-

接口功能：
  注册订阅HiSysEvent系统事件侦听对象，可设置规则订阅某些事件。

-

输入参数：

-
  • listener：订阅回调对象。
  • rules：事件订阅规则。
-

返回值：

-
  • 0：订阅成功，重复订阅。
  • 1：订阅成功，初次订阅。
  • 其他返回值：订阅失败。
-

void HiSysEventManager::RemoveListener(std::shared_ptr<HiSysEventSubscribeCallBackBase> listener)

-

接口功能：
  移除订阅hisysevent系统事件侦听对象。

-

输入参数：

-
  • listener：订阅回调对象。
-

返回值：
  无。

-
+| 接口名称 | 描述 | +| -------- | --------- | +|int HiSysEventManager::AddEventListener(std::shared_ptr<HiSysEventSubscribeCallBackBase> listener, std::vector<ListenerRule>& rules)|接口功能：注册订阅HiSysEvent系统事件侦听对象，可设置规则订阅某些事件。

输入参数：返回值：| +|void HiSysEventManager::RemoveListener(std::shared_ptr<HiSysEventSubscribeCallBackBase> listener)|接口功能：移除订阅hisysevent系统事件侦听对象。

输入参数：返回值：
  无。| **表 2** ListenerRule订阅规则对象 - - - - - - - - - - - - - - - -

接口名称

-

描述

-

ListenerRule(const std::string& tag, RuleType ruleType = RuleType::WHOLE_WORD)

-

接口功能：
  订阅规则构造函数，创建事件标签订阅规则对象。

-

输入参数：

-
    -
  • tag：订阅规则的HisysEvent事件标签，字符串类型，最大长度16个字符（含），有效字符包含大小写字母及数字。
    • -
  • ruleType：订阅规则的规则类型，RuleType枚举类型(参考表3)。
-

ListenerRule(const std::string& domain, const std::string& eventName, RuleType ruleType = RuleType::WHOLE_WORD)

-

接口功能：
  订阅规则构造函数，创建事件领域与事件名称订阅规则对象。

-

输入参数：

-
    -
  • domain：订阅规则的HisysEvent事件领域，字符串类型，最大长度16个字符（含），有效字符包含大写字母、数字及下划线。
    • -
  • eventName：订阅规则的HisysEvent事件名称，字符串类型，最大长度32个字符（含），有效字符包含大写字母、数字及下划线。
    • -
  • ruleType：订阅规则的规则类型，RuleType枚举类型(参考表3)。
-

ListenerRule(const std::string& domain, const std::string& eventName, const std::string& tag, RuleType ruleType = RuleType::WHOLE_WORD)

-

接口功能：
  订阅规则构造函数，创建事件领域、事件名称，事件标签订阅规则对象。

-

输入参数：

-
    -
  • tag：订阅规则的HisysEvent事件标签，字符串类型，最大长度16个字符（含），有效字符包含大小写字母及数字。
    • -
  • domain：订阅规则的HisysEvent事件领域，字符串类型，最大长度16个字符（含），有效字符包含大写字母、数字及下划线。
    • -
  • eventName：订阅规则的HisysEvent事件名称，字符串类型，最大长度32个字符（含），有效字符包含大写字母、数字及下划线。
    • -
  • ruleType：订阅规则的规则类型，RuleType枚举类型(参考表3)。
-
+| 接口名称 | 描述 | +| -------- | --------- | +|ListenerRule(const std::string& tag, RuleType ruleType = RuleType::WHOLE_WORD)|接口功能：订阅规则构造函数，创建事件标签订阅规则对象。

输入参数：| +|ListenerRule(const std::string& domain, const std::string& eventName, RuleType ruleType = RuleType::WHOLE_WORD)|接口功能：订阅规则构造函数，创建事件领域与事件名称订阅规则对象。

输入参数：| +|ListenerRule(const std::string& domain, const std::string& eventName, const std::string& tag, RuleType ruleType = RuleType::WHOLE_WORD)|接口功能：订阅规则构造函数，创建事件领域、事件名称，事件标签订阅规则对象。

输入参数：| **表 3** RuleType类型 @@ -104,24 +48,9 @@ HiSysEvent提供了跨进程订阅机制，开发者可以通过注册订阅接 **表 4** HiSysEventSubscribeCallBackBase订阅对象 - - - - - - - - - - -

接口名称

-

描述

-

void HiSysEventSubscribeCallBackBase::OnHandle(const std::string& domain, const std::string& eventName, const int eventType, const std::string& eventDetail)

-

接口功能：
  订阅事件的回调接口。

-

输入参数：

-
  • domain：事件所属领域。
  • eventName：事件的名称。
  • eventType：事件类型。
  • eventDetail：包含事件相关信息的字符串，以json的形式体现。
-

返回值：
  无。

-
+| 接口名称 | 描述 | +| -------- | --------- | +|void HiSysEventSubscribeCallBackBase::OnHandle(const std::string& domain, const std::string& eventName, const int eventType, const std::string& eventDetail)|接口功能：订阅事件的回调接口。

输入参数：返回值：
  无。| ### 开发实例 @@ -131,67 +60,67 @@ HiSysEvent提供了跨进程订阅机制，开发者可以通过注册订阅接 自定义订阅回调实现类头文件DemoListener.h： - ``` - #ifndef DEMO_LISTENER_H - #define DEMO_LISTENER_H + ``` + #ifndef DEMO_LISTENER_H + #define DEMO_LISTENER_H + + #include "hisysevent_subscribe_callback_native.h" - #include "hisysevent_subscribe_callback_native.h" + #include - #include + class DemoListener : public OHOS::HiviewDFX::HiSysEventSubscribeCallBackNative { + public: + explicit DemoListener() : HiSysEventSubscribeCallBackNative() {} + void OnHandle(const std::string& domain, const std::string& eventName, const int eventType, + const std::string& eventDetail); + virtual ~DemoListener() {} + void OnServiceDied(); + }; - class DemoListener : public OHOS::HiviewDFX::HiSysEventSubscribeCallBackNative { - public: - explicit DemoListener() : HiSysEventSubscribeCallBackNative() {} - void OnHandle(const std::string& domain, const std::string& eventName, const int eventType, - const std::string& eventDetail); - virtual ~DemoListener() {} - void OnServiceDied(); - }; - - #endif DEMO_LISTENER_H - ``` + #endif DEMO_LISTENER_H + ``` 增加DemoListener.cpp文件，在DemoListener类中根据实际需求自定义订阅回调接口的实现逻辑： - ``` - #include "demo_listener.h" + ``` + #include "demo_listener.h" - #include + #include - void DemoListener::OnHandle(const std::string& domain, const std::string& eventName, - const int eventType, const std::string& eventDetail) - { - std::cout << eventDetail << std::endl; - } + void DemoListener::OnHandle(const std::string& domain, const std::string& eventName, + const int eventType, const std::string& eventDetail) + { + std::cout << eventDetail << std::endl; + } - void DemoListener::OnServiceDied() - { - std::cout << std::string("service disconnect, exit") << std::endl; - exit(0); - } - ``` + void DemoListener::OnServiceDied() + { + std::cout << std::string("service disconnect, exit") << std::endl; + exit(0); + } + ``` 通过HiSysEventManager类提供的AddEventListener接口注册回调对象，完成对HiSysEvent的订阅： - ``` - auto demoListener = std::make_shared(); - // 事件标签规则订阅，规则类型为默认的全词匹配类型 - ListenerRule tagRule("dfx"); - // 事件标签规则订阅，规则类型为正则匹配类型 - ListenerRule regRule("dfx.*", RuleType::REGULAR); - // 事件领域及事件名称规则订阅，规则类型为前缀匹配类型 - ListenerRule domainNameRule("HIVIEWDFX", "APP_USAGE", RuleType::PREFIX); - std::vector sysRules; - sysRules.push_back(tagRule); - sysRules.push_back(regRule); - sysRules.push_back(domainNameRule); - HiSysEventManager::AddEventListener(demoListener, sysRules); - ``` + ``` + auto demoListener = std::make_shared(); + // 事件标签规则订阅，规则类型为默认的全词匹配类型 + ListenerRule tagRule("dfx"); + // 事件标签规则订阅，规则类型为正则匹配类型 + ListenerRule regRule("dfx.*", RuleType::REGULAR); + // 事件领域及事件名称规则订阅，规则类型为前缀匹配类型 + ListenerRule domainNameRule("HIVIEWDFX", "APP_USAGE", RuleType::PREFIX); + std::vector sysRules; + sysRules.push_back(tagRule); + sysRules.push_back(regRule); + sysRules.push_back(domainNameRule); + HiSysEventManager::AddEventListener(demoListener, sysRules); + ``` 2. 编译配置 在BUILD.gn编译文件中，需要添加依赖hisysevent\_native组件的libhisyseventmanager库： ``` - external_deps = [ "hisysevent_native:libhisyseventmanager", ] - ``` + external_deps = [ "hisysevent_native:libhisyseventmanager", ] + ``` diff --git a/zh-cn/device-dev/subsystems/subsys-dfx-hisysevent-logging-config.md b/zh-cn/device-dev/subsystems/subsys-dfx-hisysevent-logging-config.md index c2ad4365b8afa1ac646cbf4c84cf7259ba3ed600..61de310d8df384b6fe0da78f091b300701f15a2b 100644 --- a/zh-cn/device-dev/subsystems/subsys-dfx-hisysevent-logging-config.md +++ b/zh-cn/device-dev/subsystems/subsys-dfx-hisysevent-logging-config.md @@ -2,10 +2,10 @@ - [概述](#section315316685115) - [基本概念](#section123181432175143) - - [约束与限制](#section123181432175114) + - [约束与限制](#section123181432175114) - [编写yaml文件](#section123181432175113) - [yaml文件编写规则](#section123181432175133) - - [yaml文件编写样例](#section123181432175123) + - [yaml文件编写样例](#section123181432175123) - [验证yaml文件](#section123181432175115) - [配置yaml文件路径](#section123181432175135) - [编译yaml文件](#section123181432175137) @@ -37,135 +37,24 @@ - 每个事件领域可定义零个或多个事件名称，同一个事件领域内部的事件名称不能重名。 -- 每个事件名称可定义多个参数，同一个事件名称内部的参数不能重名，每个事件名称**有且只有**一个名称为__BASE的参数，此参数字段组成如表1，他自定义参数，具体字段组成如表2。 - - **表 1** __BASE参数字段说明 - - - - - - - - - - - - - - - - - - - - - - - -

字段名称

-

描述

-
-

type

- 		-

字段说明：
  必选字段，用来标识该事件名称的类型。

-

取值范围：

- -
    -
  • FAULT：错误类型。
    • -
  • STATISTIC：统计类型。
    • -
  • SECURITY：安全性。
    • -
  • BEHAVIOR：用户行为。
    • -
-
-

level

- 		-

字段作用：
  必选字段，用来标识该事件名称的级别。

-

取值范围：

- -
    -
  • CRITICAL：严重。
    • -
  • MINOR：一般。
    • -
-
-

tag

- 		-

字段作用：
  可选字段，用来标识该事件名称的标签。

-

定义规则：

- -
    -
  • 最多可同时定义5个标签，标签之间使用空格来分隔。
    • -
  • 单个标签最多包含16个字符，字符范围[a-zA-Z0-9]。
    • -
-
-

desc

- 		-

字段作用：
  必选字段，用来对该事件名称进行描述。

-

定义规则：

- -
    -
  • 至少包含3个字符，最多包含128个字符，字符范围[a-zA-Z0-9 _]
    • -
-
- - **表 2** 自定义参数字段说明 - - - - - - - - - - - - - - - - - - - -

字段名称

-

描述

-
-

type

- 		-

字段说明：
  必选字段，用来标识该参数的类型。

-

取值范围：

- -
    -
  • BOOL
    • -
  • INT8
    • -
  • UINT8
    • -
  • INT16
    • -
  • UINT16
    • -
  • INT32
    • -
  • UINT32
    • -
  • INT64
    • -
  • UINT64
    • -
  • FLOAT
    • -
  • DOUBLE
    • -
  • STRING
    • -
-
-

arrsize

- 		-

字段作用：
  可选字段，用来标识数组类型参数的长度。

-

取值范围：
   1~100

- -
-

desc

- 		-

字段作用：
  必选字段，用来对该参数进行描述。

-

定义规则：

- -
    -
  • 至少包含3个字符，最多包含128个字符，字符范围[a-zA-Z0-9 _]
    • -
-
+- 每个事件名称可定义多个参数，同一个事件名称内部的参数不能重名，每个事件名称**有且只有**一个名称为__BASE的参数，此参数字段组成如表1，其它自定义参数，具体字段组成如表2。 + + **表 1** __BASE参数字段说明 + + | 字段名称 | 描述 | + | ----- | ----- | + | type | 字段说明：必选字段，用来标识该事件名称的类型。

取值范围：
  • FAULT：错误类型。
  • STATISTIC：统计类型。
  • SECURITY：安全性。
  • BEHAVIOR：用户行为。
| + | level | 字段说明：必选字段，用来标识该事件名称的级别。

取值范围：
  • CRITICAL：严重。
  • MINOR：一般。
| + | tag | 字段说明：可选字段，用来标识该事件名称的标签。

定义规则：
  • 最多可同时定义5个标签，标签之间使用空格来分隔。
  • 单个标签最多包含16个字符，字符范围[a-zA-Z0-9]
| + | desc | 字段说明：必选字段，用来对该事件名称进行描述。

定义规则：
  • 至少包含3个字符，最多包含128个字符，字符范围[a-zA-Z0-9 _]
| + + **表 2** 自定义参数字段说明 + + | 字段名称 | 描述 | + | ----- | ----- | + | type | 字段说明：必选字段，用来标识该参数的类型。

取值范围：
  • BOOL
  • UINT8
  • UINT16
  • INT32
  • UINT32
  • UINT64
  • FLOAT
  • DOUBLE
  • STRING
| + | arrsize | 字段作用：可选字段，用来标识数组类型参数的长度。

取值范围：
  • 1~100
| + | desc | 字段作用：必选字段，用来对该参数进行描述。

定义规则：
  • 至少包含3个字符，最多包含128个字符，字符范围[a-zA-Z0-9 _]
| ## 编写yaml文件 @@ -186,8 +75,8 @@ ### yaml文件编写样例 - yaml文件样例指定的事件领域名称为MODULEA，该事件领域包含两个事件，名称分别是EVENT_NAMEA和EVENT_NAMEB。 -- EVENT_NAMEA被定义成错误类型的严重事件，该事件包含类型为字符串类型的NAME1参数、字符串类型的NAME2参数及无符号短整型类型的NAME3参数，可以通过事件领域MODULEA和事件名称EVENT_NAMEA对其进行[实时订阅](subsys-dfx-hisysevent-read.md)。 -- EVENT_NAMEB被定义成统计类型的一般事件，EVENT_NAMEB包含类型为无符号短整型类型的NAME1参数及整型类型的NAME2参数。因为EVENT_NAMEB在__BASE参数中定义了名称为tag1和tag2的两个事件标签，所以不仅可以通过事件领域MODULEA和事件名称EVENT_NAMEB对其进行[实时订阅](subsys-dfx-hisysevent-read.md)，，所以还可以通过事件标签对该事件进行[实时订阅](subsys-dfx-hisysevent-read.md)。 +- EVENT_NAMEA被定义成错误类型的严重事件，该事件包含类型为字符串类型的NAME1参数、字符串类型的NAME2参数及无符号短整型类型的NAME3参数，可以通过事件领域MODULEA和事件名称EVENT_NAMEA对其进行[实时订阅](subsys-dfx-hisysevent-listening.md)。 +- EVENT_NAMEB被定义成统计类型的一般事件，EVENT_NAMEB包含类型为无符号短整型类型的NAME1参数及整型类型的NAME2参数。因为EVENT_NAMEB在__BASE参数中定义了名称为tag1和tag2的两个事件标签，所以不仅可以通过事件领域MODULEA和事件名称EVENT_NAMEB对其进行[实时订阅](subsys-dfx-hisysevent-read.md)，，所以还可以通过事件标签对该事件进行[实时订阅](subsys-dfx-hisysevent-listening.md)。 ``` ########################################## @@ -266,7 +155,7 @@ ``` cd 工程根目录的绝对路径 - ./build --product-name + ./build --product-name ``` - 全量编译生成的hisysevent.def文件可以通过以下命令获取： @@ -285,31 +174,12 @@ ./build/ohos/hisysevent/gen_def_from_all_yaml.py --yaml-list --def-path ``` - **表 3** 单文件编译参数说明 - - - - - - - - - - - - - -

选项名称

-

描述

-
-

--yaml-list

- 		-

指定需要编译的yaml文件路径列表，多个yaml文件路径之间用空格分隔。

-
-

--def-path

- 		-

指定编译生成的hisysevent.def文件的生成路径。

-
+ **表 3** 单文件编译参数说明 + + | 选项名称 | 描述 | + | ------ | ------ | + | --yaml-list | 指定需要编译的yaml文件路径列表，多个yaml文件路径之间用空格分隔。 | + | --def-path | 指定编译生成的hisysevent.def文件的生成路径。 | ### 打点及查询定义的事件 diff --git a/zh-cn/device-dev/subsystems/subsys-dfx-hisysevent-logging.md b/zh-cn/device-dev/subsystems/subsys-dfx-hisysevent-logging.md index 9c1d8f01608fa1242fcda3c212a2d424c2b296a0..f653c1062f9d3762960d3587ffe6d645593104f7 100644 --- a/zh-cn/device-dev/subsystems/subsys-dfx-hisysevent-logging.md +++ b/zh-cn/device-dev/subsystems/subsys-dfx-hisysevent-logging.md @@ -2,7 +2,7 @@ - [概述](#section77571101789) - [功能简介](#section123133332175224) - - [约束与限制](#section123181432175224) + - [约束与限制](#section123181432175224) - [开发指导](#section314416685113) - [接口说明](#section13480315886) - [开发实例](#section112771171317) @@ -17,7 +17,7 @@ HiSysEvent提供OpenHarmony打点接口，通过在关键路径打点记录系 **HiSysEvent事件打点条件约束：** -- 在进行HiSysEvent事件打点之前，需要先完成HiSysEvent打点配置，具体配置方法请参考[《HiSysEvent打点配置指导》](subsys-dfx-hisysevent-write-config.md)。 +- 在进行HiSysEvent事件打点之前，需要先完成HiSysEvent打点配置，具体配置方法请参考[《HiSysEvent打点配置指导》](subsys-dfx-hisysevent-logging-config.md)。 ## 开发指导 @@ -29,247 +29,59 @@ HiSysEvent类，具体的API详见接口文档 。 **表 1** HiSysEvent接口介绍 - - - - - - - - - -

接口名

-

描述

-

template<typename... Types> static int Write(const std::string &domain, const std::string &eventName, EventType type, Types... keyValues)

-

接口功能：记录系统事件。

-

输入参数：

-
  • domain：事件的相关领域，需要使用预置领域请参考Domain，可自定义领域。自定义领域长度在16个字符以内，有效的字符是0-9、A-Z，以字母开头。
  • eventName：事件名，长度在32个字符以内，有效的字符是0-9、A-Z、_，以字母开头，不能以_结尾。
  • type：事件类型，参考EventType。
  • keyValues：事件参数键值对，支持基本的数据类型、std::string，以及std::vector<基本类型>、std:vector<std::string>。参数名长度在48个字符以内，有效的字符是0-9、A-Z、_，以字母开头，不能以_结尾。参数名的个数在32个以内。
-

返回值：成功返回0，错误返回小于0的值。

-
+| 接口名称 | 描述 | +| -------- | --------- | +| template<typename... Types> static int Write(const std::string &domain, const std::string &eventName, EventType type, Types... keyValues) | 接口功能：记录系统事件。

输入参数：
  • domain：事件的相关领域，需要使用预置领域请参考Domain，可自定义领域。自定义领域长度在16个字符以内，有效的字符是0-9、A-Z，以字母开头。
  • eventName：事件名，长度在32个字符以内，有效的字符是0-9、A-Z、下划线，以字母开头，不能以下划线结尾。
  • type：事件类型，参考EventType。
  • keyValues：事件参数键值对，支持基本的数据类型、std::string，以及std::vector<基本类型>、std:vector<std::string>。参数名长度在48个字符以内，有效的字符是0-9、A-Z、下划线，以字母开头，不能以下划线结尾。参数名的个数在32个以内。
返回值：
  • 0：系统事件记录成功。
  • 负值：系统事件记录失败。
| **表 2** HiSysEvent::Domain接口介绍 - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -

成员

-

描述

-

static const std::string AAFWK

-

元能力子系统

-

static const std::string APPEXECFWK

-

用户程序框架子系统

-

static const std::string ACCOUNT

-

账号子系统

-

static const std::string ACE

-

ACE子系统

-

static const std::string AI

-

AI业务子系统

-

static const std::string BARRIER_FREE

-

无障碍软件服务子系统

-

static const std::string BIOMETRICS

-

生物特征识别服务子系统

-

static const std::string CCRUNTIME

-

C/C++运行环境子系统

-

static const std::string COMMUNICATION

-

公共通信子系统

-

static const std::string DEVELOPTOOLS

-

研发工具链子系统

-

static const std::string DISTRIBUTED_DATAMGR

-

分布式数据管理子系统

-

static const std::string DISTRIBUTED_SCHEDULE

-

分布式任务调度子系统

-

static const std::string GLOBAL

-

全球化子系统

-

static const std::string GRAPHIC

-

图形子系统

-

static const std::string HIVIEWDFX

-

DFX子系统

-

static const std::string IAWARE

-

本地资源调度管控子系统

-

static const std::string INTELLI_ACCESSORIES

-

智能配件业务子系统

-

static const std::string INTELLI_TV

-

智能电视业务子系统

-

static const std::string IVI_HARDWARE

-

车机专有硬件服务子系统

-

static const std::string LOCATION

-

位置服务子系统

-

static const std::string MSDP

-

综合传感处理平台子系统

-

static const std::string MULTI_MEDIA

-

媒体子系统

-

static const std::string MULTI_MODAL_INPUT

-

多模输入子系统

-

static const std::string NOTIFICATION

-

事件通知子系统

-

static const std::string POWERMGR

-

电源服务子系统

-

static const std::string ROUTER

-

路由器业务子系统

-

static const std::string SECURITY

-

安全子系统

-

static const std::string SENSORS

-

泛Sensor服务子系统

-

static const std::string SOURCE_CODE_TRANSFORMER

-

应用移植子系统

-

static const std::string STARTUP

-

启动恢复子系统

-

static const std::string TELEPHONY

-

电话服务子系统

-

static const std::string UPDATE

-

升级服务子系统

-

static const std::string USB

-

USB服务子系统

-

static const std::string WEARABLE_HARDWARE

-

穿戴专有硬件服务子系统

-

static const std::string WEARABLE

-

穿戴业务子系统

-

static const std::string OTHERS

-

其它

-
+| 成员名称 | 描述 | +| -------- | --------- | +| static const std::string AAFWK | 元能力子系统 | +| static const std::string APPEXECFWK | 用户程序框架子系统 | +| static const std::string ACCOUNT | 账号子系统 | +| static const std::string ACE | ACE子系统 | +| static const std::string AI | AI业务子系统 | +| static const std::string BARRIER_FREE | 无障碍软件服务子系统 | +| static const std::string BIOMETRICS | 生物特征识别服务子系统 | +| static const std::string CCRUNTIME |C/C++运行环境子系统 | +| static const std::string COMMUNICATION | 公共通信子系统 | +| static const std::string DEVELOPTOOLS | 研发工具链子系统 | +| static const std::string DISTRIBUTED_DATAMGR | 分布式数据管理子系统 | +| static const std::string DISTRIBUTED_SCHEDULE | 分布式任务调度子系统 | +| static const std::string GLOBAL | 全球化子系统 | +| static const std::string GRAPHIC | 图形子系统 | +| static const std::string HIVIEWDFX | DFX子系统 | +| static const std::string IAWARE | 本地资源调度管控子系统 | +| static const std::string INTELLI_ACCESSORIES | 智能配件业务子系统 | +| static const std::string INTELLI_TV | 智能电视业务子系统 | +| static const std::string IVI_HARDWARE | 车机专有硬件服务子系统 | +| static const std::string LOCATION | 位置服务子系统 | +| static const std::string MSDP | 综合传感处理平台子系统 | +| static const std::string MULTI_MEDIA | 媒体子系统 | +| static const std::string MULTI_MODAL_INPUT | 多模输入子系统 | +| static const std::string NOTIFICATION | 事件通知子系统 | +| static const std::string POWERMGR | 电源服务子系统 | +| static const std::string ROUTER | 路由器业务子系统 | +| static const std::string SECURITY | 安全子系统 | +| static const std::string SENSORS | 泛Sensor服务子系统 | +| static const std::string SOURCE_CODE_TRANSFORMER | 应用移植子系统 | +| static const std::string STARTUP | 启动恢复子系统 | +| static const std::string TELEPHONY | 电话服务子系统 | +| static const std::string UPDATE | 升级服务子系统 | +| static const std::string USB | USB服务子系统 | +| static const std::string WEARABLE_HARDWARE | 穿戴专有硬件服务子系统 | +| static const std::string WEARABLE_HARDWARE | 穿戴业务子系统 | +| static const std::string OTHERS | 其它 | **表 3** HiSysEvent::EventType接口介绍 - - - - - - - - - - - - - - - - - - -

接口名

-

描述

-

FAULT

-

故障类型事件

-

STATISTIC

-

统计类型事件

-

SECURITY

-

安全类型事件

-

BEHAVIOR

-

系统行为事件

-
+| 接口名称 | 描述 | +| -------- | --------- | +| FAULT | 故障类型事件 | +| STATISTIC | 统计类型事件 | +| SECURITY | 安全类型事件 | +| BEHAVIOR | 系统行为事件 | ### 开发实例 diff --git a/zh-cn/device-dev/subsystems/subsys-dfx-hisysevent-querying.md b/zh-cn/device-dev/subsystems/subsys-dfx-hisysevent-querying.md index 867e8eef6e4faa81def895e53d75344a08445eaa..93a6fb09c64b33e67acb879662f240f500fa6dd3 100644 --- a/zh-cn/device-dev/subsystems/subsys-dfx-hisysevent-querying.md +++ b/zh-cn/device-dev/subsystems/subsys-dfx-hisysevent-querying.md @@ -15,106 +15,33 @@ HiSysEvent提供了查询接口，支持开发者设置条件查询HiSysEvent事 **表 1** HiSysEvent查询接口 - - - - - - - - - -

接口名

-

描述

-

bool HiSysEventManager::QueryHiSysEvent(struct QueryArg& queryArg, std::vector<struct QueryRule>& queryRules, std::shared_ptr<HiSysEventQueryCallBackBase> queryCallBack)

-

接口功能：支持设置查询时间段，事件领域，事件名称等，查询满足条件的HiSysEvent事件。

-

输入参数：

-
  • queryArg：查询参数。
  • queryRules：事件过滤规则。
  • queryCallBack：查询接口回调对象。
-

返回值：

-
  • true：查询成功。
  • false：查询失败。
-
+| 接口名称 | 描述 | +| -------- | --------- | +| bool HiSysEventManager::QueryHiSysEvent(struct QueryArg& queryArg, std::vector<struct QueryRule>& queryRules, std::shared_ptr<HiSysEventQueryCallBackBase> queryCallBack) | 接口功能：
  支持设置查询时间段，事件领域，事件名称等，查询满足条件的HiSysEvent事件。

输入参数：
  • queryArg：查询参数。
  • queryRules：事件过滤规则。
  • queryCallBack：查询接口回调对象。
返回值：
  • true：查询成功。
  • false：查询失败。
| + **表 2** QueryArg查询参数对象 - - - - - - - - - - - - - - - -

属性名称

-

描述

-

long long beginTime

-

事件开始时间。

-

long long endTime

-

事件结束事件。

-

int maxEvents

-

返回最大的查询条数。

-
+| 属性名称 | 描述 | +| -------- | --------- | +| beginTime | long long int类型，用于指定查询事件的开始时间。 | +| endTime | long long int类型，用于指定查询事件的结束时间。 | +| maxEvents | int类型，用于指定查询返回事件查询的最多条数。 | **表 3** QueryRule查询规则对象 - - - - - - - - - - - - - - - -

属性名称

-

描述

-

uint32_t ruleType

-

规则类型，目前默认是0。

-

std::string domain;

-
  • domain：事件所属领域，如果传入的是空字符串，则默认事件领域字段匹配成功。
-

std::vector<std::string> eventList

-
  • eventList：事件名称的列表，如果传入的是空字符串，则默认事件名称字段匹配成功。
-
+| 属性名称 | 描述 | +| -------- | --------- | +| ruleType | uint32_t类型，用来标识查询规则对象的规则类型，默认是0。 | +| domain | string类型，用来标识查询规则对象的事件所属领域，如果传入的是空字符串，则默认事件领域字段匹配成功。 | +| eventList | std::vector<std::string>类型，事件名称的列表，如果传入的是空字符串，则默认事件名称字段匹配成功。 | **表 4** HiSysEventQueryCallBackBase查询回调对象 - - - - - - - - - - - - -

接口名称

-

描述

-

void HiSysEventQueryCallBackBase::OnQuery(const ::std::vector<std::string>& sysEvent, const ::std::vector<int64_t>& seq)

-

接口功能：订阅事件查询中的回调。

-

输入参数：

-
  • sysEvent：返回事件集合。
  • seq：事件序列集合。
-

返回值：无。

-

void HiSysEventQueryCallBackBase::OnComplete(int32_t reason, int32_t total)

-

接口功能：订阅事件查询完成的回调。

-

输入参数：

-
  • reason：查询结束返回原因，目前默认是0。
  • total：本次查询总共返回的事件总数量。
-

返回值：无。

-
+| 接口名称 | 描述 | +| -------- | --------- | +| void HiSysEventQueryCallBackBase::OnQuery(const ::std::vector<std::string>& sysEvent, const ::std::vector<int64_t>& seq) | 接口功能：订阅事件查询中的回调。

输入参数：
  • sysEvent：返回事件集合。
  • seq：事件序列集合。
返回值：
  无。 | +| void HiSysEventQueryCallBackBase::OnComplete(int32_t reason, int32_t total) | 接口功能：订阅事件查询完成的回调。

输入参数：
  • reason：查询结束返回原因，目前默认是0。
  • total：本次查询总共返回的事件总数量。
返回值：
  无。 | ### 开发实例 diff --git a/zh-cn/device-dev/subsystems/subsys-dfx-hisysevent.md b/zh-cn/device-dev/subsystems/subsys-dfx-hisysevent.md old mode 100755 new mode 100644 index 26043db5cafd11df0b0166eb8c5acbbc0a77e5a3..48e52474a463c553676526c6c31b2ef53c55f7f0 --- a/zh-cn/device-dev/subsystems/subsys-dfx-hisysevent.md +++ b/zh-cn/device-dev/subsystems/subsys-dfx-hisysevent.md @@ -6,6 +6,6 @@ - **[HiSysEvent订阅指导](subsys-dfx-hisysevent-listening.md)** -- **[HiSysEvent查询指导](subsys-dfx-hisysevent-query.md)** +- **[HiSysEvent查询指导](subsys-dfx-hisysevent-querying.md)** - **[HiSysEvent工具使用指导](subsys-dfx-hisysevent-tool.md)** \ No newline at end of file diff --git a/zh-cn/website-directory.md b/zh-cn/website-directory.md index 67cc8979d830c6f55db5fc17ae361d8554d1ec33..38ddb94c81f4edf0ec83cdbc235437bb434e6225 100644 --- a/zh-cn/website-directory.md +++ b/zh-cn/website-directory.md @@ -912,11 +912,13 @@ ——>——>——>——>[HiSysEvent开发指导](device-dev/subsystems/subsys-dfx-hisysevent.md) -——>——>——>——>——>[HiSysEvent打点指导](device-dev/subsystems/subsys-dfx-hisysevent-write.md) +——>——>——>——>——>[HiSysEvent打点配置指导](device-dev/subsystems/subsys-dfx-hisysevent-logging-config.md) -——>——>——>——>——>[HiSysEvent订阅指导](device-dev/subsystems/subsys-dfx-hisysevent-read.md) +——>——>——>——>——>[HiSysEvent打点指导](device-dev/subsystems/subsys-dfx-hisysevent-logging.md) -——>——>——>——>——>[HiSysEvent查询指导](device-dev/subsystems/subsys-dfx-hisysevent-select.md) +——>——>——>——>——>[HiSysEvent订阅指导](device-dev/subsystems/subsys-dfx-hisysevent-listening.md) + +——>——>——>——>——>[HiSysEvent查询指导](device-dev/subsystems/subsys-dfx-hisysevent-querying.md) ——>——>——>——>——>[HiSysEvent工具使用指导](device-dev/subsystems/subsys-dfx-hisysevent-tool.md) @@ -1964,4 +1966,4 @@ ——>——>——>[社区沟通与交流](contribute/社区沟通与交流.md) -——>——>——>[FAQ](contribute/FAQ.md) \ No newline at end of file +——>——>——>[FAQ](contribute/FAQ.md)