From d974eae4607a59f4da0c9104f43c74b8c922d801 Mon Sep 17 00:00:00 2001 From: xuyong Date: Wed, 9 Feb 2022 15:41:59 +0800 Subject: [PATCH] =?UTF-8?q?hisysevent=20tag=E8=AE=A2=E9=98=85=E6=96=87?= =?UTF-8?q?=E6=A1=A3=E6=9B=B4=E6=96=B0?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: xuyong --- .../subsystems/subsys-dfx-hisysevent-tool.md | 122 +++---- .../subsys-dfx-hisysevent-write-config.md | 340 +++++++++--------- .../subsystems/subsys-dfx-hisysevent-write.md | 8 +- 3 files changed, 236 insertions(+), 234 deletions(-) diff --git a/zh-cn/device-dev/subsystems/subsys-dfx-hisysevent-tool.md b/zh-cn/device-dev/subsystems/subsys-dfx-hisysevent-tool.md index 811bd0ce40..7f27de82e6 100644 --- a/zh-cn/device-dev/subsystems/subsys-dfx-hisysevent-tool.md +++ b/zh-cn/device-dev/subsystems/subsys-dfx-hisysevent-tool.md @@ -10,93 +10,93 @@ ## 实时订阅HiSysEvent事件相关命令 -- 实时订阅HiSysEvent事件的基础命令： +- 实时订阅HiSysEvent事件的基础命令： -``` -hisysevent -r -``` + ``` + hisysevent -r + ``` -选项说明： + 选项说明： -| 选项名称 | 功能说明 | -| -------- | --------- | -| -r  | 以缺省设置实时订阅HiSysEvent事件，在此种订阅方式下有任何实时HiSysEvent事件产生，都会在控制台上打印此HiSysEvent事件 | + | 选项名称 | 功能说明 | + | -------- | --------- | + | -r  | 以缺省设置实时订阅HiSysEvent事件，在此种订阅方式下有任何实时HiSysEvent事件产生，都会在控制台上打印此HiSysEvent事件 | -- 打开调试模式： +- 打开调试模式： -``` -hisysevent -r -d -``` + ``` + hisysevent -r -d + ``` -选项说明： + 选项说明： -| 选项名称 | 功能说明 | -| -------- | --------- | -| -d | 在调试模式下实时订阅HiSysEvent事件 | + | 选项名称 | 功能说明 | + | -------- | --------- | + | -d | 在调试模式下实时订阅HiSysEvent事件 | -- 通过事件标签方式实时订阅HiSysEvent事件： +- 通过事件标签方式实时订阅HiSysEvent事件： -``` -hisysevnet -r -t [-c [WHOLE_WORD|PREFIX|REGULAR]] -``` + ``` + hisysevnet -r -t [-c [WHOLE_WORD|PREFIX|REGULAR]] + ``` -选项说明： + 选项说明： -| 选项名称 | 功能说明 | -| -------- | --------- | -| -t  | 设置实时订阅的HiSysEvent事件标签，用来过滤订阅的HiSysEvent事件 | -| -c  | 设置实时订阅的HiSysEvent事件标签匹配规则，有“WHOLE_WORD”、“PREFIX”、“REGULAR”三种匹配规则| + | 选项名称 | 功能说明 | + | -------- | --------- | + | -t  | 设置实时订阅的HiSysEvent事件标签，用来过滤订阅的HiSysEvent事件 | + | -c  | 设置实时订阅的HiSysEvent事件标签匹配规则，有“WHOLE_WORD”、“PREFIX”、“REGULAR”三种匹配规则| -- 通过事件领域及事件名称的方式实时订阅HiSysEvent事件： +- 通过事件领域及事件名称的方式实时订阅HiSysEvent事件： -``` -hisysevent -r -o -n [-c [WHOLE_WORD|PREFIX|REGULAR]] -``` + ``` + hisysevent -r -o -n [-c [WHOLE_WORD|PREFIX|REGULAR]] + ``` -| 选项名称 | 功能说明 | -| -------- | --------- | -| -o | 设置实时订阅的HiSysEvent事件领域，用来过滤订阅的HiSysEvent事件 | -| -n | 设置实时订阅的HiSysEvent事件名称，用来过滤订阅的HiSysEvent事件| -| -c | 设置实时订阅的HiSysEvent事件领域及事件名称的匹配规则，有“WHOLE_WORD”、“PREFIX”、“REGULAR”三种匹配规则| + | 选项名称 | 功能说明 | + | -------- | --------- | + | -o | 设置实时订阅的HiSysEvent事件领域，用来过滤订阅的HiSysEvent事件 | + | -n | 设置实时订阅的HiSysEvent事件名称，用来过滤订阅的HiSysEvent事件| + | -c | 设置实时订阅的HiSysEvent事件领域及事件名称的匹配规则，有“WHOLE_WORD”、“PREFIX”、“REGULAR”三种匹配规则| ->![](../public_sys-resources/icon-note.gif) **说明：** ->当同时通过-t、-o及-n指定了相关订阅规则参数设置，则判断设置的事件标签是否为空，若不为空，则使用事件标签规则进行订阅，否则使用事件领域及事件名称订阅规则进行订阅。 + >![](../public_sys-resources/icon-note.gif) **说明：** + >当同时通过-t、-o及-n指定了相关订阅规则参数设置，则判断设置的事件标签是否为空，若不为空，则使用事件标签规则进行订阅，否则使用事件领域及事件名称订阅规则进行订阅。 ## 查询历史HiSysEvent事件相关命令 -- 查询历史HiSysEvent事件的基础命令： +- 查询历史HiSysEvent事件的基础命令： -``` -hisysevent -l -``` + ``` + hisysevent -l + ``` -选项说明： + 选项说明： -| 选项名称 | 功能说明 | -| -------- | --------- | -| -l | 以缺省设置查询历史HiSysEvent事件，此次查询会返回最近不多于1000条的HiSysEvent事件 | + | 选项名称 | 功能说明 | + | -------- | --------- | + | -l | 以缺省设置查询历史HiSysEvent事件，此次查询会返回最近不多于1000条的HiSysEvent事件 | -- 通过设置开始/结束时间，过滤查询历史HiSysEvent事件的结果的命令： +- 通过设置开始/结束时间，过滤查询历史HiSysEvent事件的结果的命令： -``` -hisysevent -l -s -e -``` + ``` + hisysevent -l -s -e + ``` -选项说明： + 选项说明： -| 选项名称 | 功能说明 | -| -------- | --------- | -| -s | 设置查询历史HiSysEvent事件的开始时间，此次查询只会返回不早于该时间点的HiSysEvent事件 | -| -e | 设置查询历史HiSysEvent事件的结束时间，此次查询只会返回不晚于该时间点的HiSysEvent事件 | + | 选项名称 | 功能说明 | + | -------- | --------- | + | -s | 设置查询历史HiSysEvent事件的开始时间，此次查询只会返回不早于该时间点的HiSysEvent事件 | + | -e | 设置查询历史HiSysEvent事件的结束时间，此次查询只会返回不晚于该时间点的HiSysEvent事件 | -- 通过设置最大数量值，限制查询历史HiSysEvent事件的数量： +- 通过设置最大数量值，限制查询历史HiSysEvent事件的数量： -``` -hisysevent -l -m -``` + ``` + hisysevent -l -m + ``` -选项说明： + 选项说明： -| 选项名称 | 功能说明 | -| -------- | --------- | -| -m | 设置查询历史HiSysEvent事件的数量，有效值范围[0,1000]，此次查询返回的HiSysEvent事件数目不会多于此值。 | + | 选项名称 | 功能说明 | + | -------- | --------- | + | -m | 设置查询历史HiSysEvent事件的数量，有效值范围[0,1000]，此次查询返回的HiSysEvent事件数目不会多于此值。 | diff --git a/zh-cn/device-dev/subsystems/subsys-dfx-hisysevent-write-config.md b/zh-cn/device-dev/subsystems/subsys-dfx-hisysevent-write-config.md index 2d1dfcafce..c2ad4365b8 100644 --- a/zh-cn/device-dev/subsystems/subsys-dfx-hisysevent-write-config.md +++ b/zh-cn/device-dev/subsystems/subsys-dfx-hisysevent-write-config.md @@ -39,133 +39,133 @@ - 每个事件名称可定义多个参数，同一个事件名称内部的参数不能重名，每个事件名称**有且只有**一个名称为__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 _]
    • -
-
+ **表 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 _]
    • +
+
## 编写yaml文件 @@ -189,24 +189,24 @@ - 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)。 -``` -########################################## -# 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} -``` + ``` + ########################################## + # 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文件 @@ -285,31 +285,31 @@ EVENT_NAMEB: ./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-write.md b/zh-cn/device-dev/subsystems/subsys-dfx-hisysevent-write.md index 0712bbd24b..b73260e797 100644 --- a/zh-cn/device-dev/subsystems/subsys-dfx-hisysevent-write.md +++ b/zh-cn/device-dev/subsystems/subsys-dfx-hisysevent-write.md @@ -1,7 +1,7 @@ # HiSysEvent打点指导 - [概述](#section77571101789) -- [打点配置](#section112771171321) + - [约束与限制](#section123181432175224) - [接口说明](#section13480315886) - [开发实例](#section112771171317) @@ -9,9 +9,11 @@ HiSysEvent提供OpenHarmony打点接口，通过在关键路径打点记录系统在运行过程中的重要信息，辅助开发者定位问题，此外还支持开发者将数据上传到云进行大数据质量度量。 -## 打点配置 +### 约束与限制 -在进行HiSysEvent事件打点之前，需要先对HiSysEvent事件打点进行配置，具体可参考[《HiSysEvent打点配置指导》](subsys-dfx-hisysevent-write-config.md)。 +**HiSysEvent事件打点条件约束：** + +- HiSysEvent事件打点结果取决于该HiSysEvent事件是否已在组件中进行配置，具体配置方法请参考[《HiSysEvent打点配置指导》](subsys-dfx-hisysevent-write-config.md)。 ## 接口说明 -- GitLab