提交 3b52a7ae 编写于 作者: X xuyong

hisysevent tag订阅文档更新

Signed-off-by: Nxuyong <xuyong59@huawei.com>
上级 f10a1917
......@@ -10,7 +10,7 @@
## 实时订阅HiSysEvent事件相关命令<a name="section1210623418527"></a>
实时订阅HiSysEvent事件的基础命令:
- 实时订阅HiSysEvent事件的基础命令:
```
hisysevent -r
......@@ -20,9 +20,9 @@ hisysevent -r
| 选项名称 | 功能说明 |
| -------- | --------- |
| -r&nbsp; | 以缺省设置实时订阅HiSysEvent事件,在此种订阅方式下有任何实时HiSysEvent事件产生,都会在控制台上打印此HiSysEvent事件 |
| -r&nbsp; | 以缺省设置实时订阅HiSysEvent事件,在此种订阅方式下有任何实时HiSysEvent事件产生,都会在控制台上打印此HiSysEvent事件 |
打开调试模式:
- 打开调试模式:
```
hisysevent -r -d
......@@ -32,9 +32,9 @@ hisysevent -r -d
| 选项名称 | 功能说明 |
| -------- | --------- |
| -d | 在调试模式下实时订阅HiSysEvent事件 |
| -d | 在调试模式下实时订阅HiSysEvent事件 |
通过事件标签方式实时订阅HiSysEvent事件:
- 通过事件标签方式实时订阅HiSysEvent事件:
```
hisysevnet -r -t <tag> [-c [WHOLE_WORD|PREFIX|REGULAR]]
......@@ -47,7 +47,7 @@ hisysevnet -r -t <tag> [-c [WHOLE_WORD|PREFIX|REGULAR]]
| -t&nbsp; | 设置实时订阅的HiSysEvent事件标签,用来过滤订阅的HiSysEvent事件 |
| -c&nbsp; | 设置实时订阅的HiSysEvent事件标签匹配规则,有“WHOLE_WORD”、“PREFIX”、“REGULAR”三种匹配规则|
4. 通过事件领域及事件名称的方式实时订阅HiSysEvent事件:
- 通过事件领域及事件名称的方式实时订阅HiSysEvent事件:
```
hisysevent -r -o <domain> -n <eventName> [-c [WHOLE_WORD|PREFIX|REGULAR]]
......@@ -64,7 +64,7 @@ hisysevent -r -o <domain> -n <eventName> [-c [WHOLE_WORD|PREFIX|REGULAR]]
## 查询历史HiSysEvent事件相关命令<a name="section1210623418539"></a>
查询历史HiSysEvent事件的基础命令:
- 查询历史HiSysEvent事件的基础命令:
```
hisysevent -l
......@@ -74,9 +74,9 @@ hisysevent -l
| 选项名称 | 功能说明 |
| -------- | --------- |
| -l | 以缺省设置查询历史HiSysEvent事件,此次查询会返回最近不多于1000条的HiSysEvent事件 |
| -l | 以缺省设置查询历史HiSysEvent事件,此次查询会返回最近不多于1000条的HiSysEvent事件 |
通过设置开始/结束时间,过滤查询历史HiSysEvent事件的结果的命令:
- 通过设置开始/结束时间,过滤查询历史HiSysEvent事件的结果的命令:
```
hisysevent -l -s <begin time> -e <end time>
......@@ -89,7 +89,7 @@ hisysevent -l -s <begin time> -e <end time>
| -s | 设置查询历史HiSysEvent事件的开始时间,此次查询只会返回不早于该时间点的HiSysEvent事件 |
| -e | 设置查询历史HiSysEvent事件的结束时间,此次查询只会返回不晚于该时间点的HiSysEvent事件 |
通过设置最大数量值,限制查询历史HiSysEvent事件的数量:
- 通过设置最大数量值,限制查询历史HiSysEvent事件的数量:
```
hisysevent -l -m <max hisysevent count>
......
......@@ -19,22 +19,25 @@
在配置HiSysEvent打点之前,开发者应了解以下基本概念:
- 事件领域:用于标识事件所属的领域,在yaml文件中以domain为键值指定,可参考yaml文件样例中的[domain](#section123181432175123)
- 事件领域
用于标识事件所属的领域,在yaml文件中以domain为键值指定,可参考yaml文件样例中的[domain](#section123181432175123)
- 事件名称:用于指定事件领域包含的所有事件,可参考yaml文件样例中的[EVENT_NAMEA/EVENT_NAMEB](#section123181432175123)
- 事件名称
用于指定事件领域包含的所有事件,可参考yaml文件样例中的[EVENT_NAMEA/EVENT_NAMEB](#section123181432175123)
- 参数:用于定义某个事件名称包含的所有键值,可参考yaml文件样例中的[__BASE/NAME1/NAME2](#section123181432175123)
- 参数
用于定义某个事件名称包含的所有键值,可参考yaml文件样例中的[__BASE/NAME1/NAME2](#section123181432175123)
### 约束与限制<a name="section123181432175114"></a>
**定义事件领域、事件名称及参数的约束与限制:**
- 事件领域:每个yaml文件只能有一个事件领域,且不能与其他事件领域重名。
- 每个yaml文件只能有一个事件领域,且不能与其他事件领域重名。
- 事件名称:每个事件领域可定义零个或多个事件名称,同一个事件领域内部的事件名称不能重名。
- 每个事件领域可定义零个或多个事件名称,同一个事件领域内部的事件名称不能重名。
- 参数:每个事件名称可定义多个参数,同一个事件名称内部的参数不能重名,每个事件名称**有且只有**一个名称为__BASE的参数,此参数字段组成如表1,他自定义参数,具体字段组成如表2。
- 每个事件名称可定义多个参数,同一个事件名称内部的参数不能重名,每个事件名称**有且只有**一个名称为__BASE的参数,此参数字段组成如表1,他自定义参数,具体字段组成如表2。
**表 1** __BASE参数字段说明
......
# HiSysEvent打点指导<a name="ZH-CN_TOPIC_0000001231373947"></a>
- [概述](#section77571101789)
- [打点配置](#section112771171321)
- [接口说明](#section13480315886)
- [开发实例](#section112771171317)
- [打点配置指导](#section112771171321)
## 概述<a name="section77571101789"></a>
HiSysEvent提供OpenHarmony打点接口,通过在关键路径打点记录系统在运行过程中的重要信息,辅助开发者定位问题,此外还支持开发者将数据上传到云进行大数据质量度量。
## 打点配置<a name="section112771171321"></a>
在进行HiSysEvent事件打点之前,需要先对HiSysEvent事件打点进行配置,具体可参考[《HiSysEvent打点配置指导》](subsys-dfx-hisysevent-write-config.md)
## 接口说明<a name="section13480315886"></a>
C++打点接口如下:
......@@ -282,7 +286,3 @@ C++接口实例
```
external_deps = [ "hisysevent_native:libhisysevent" ]
```
## 打点配置指导<a name="section112771171321"></a>
在进行HiSysEvent事件打点之前,需要先对HiSysEvent事件打点进行配置,具体可参考[《HiSysEvent打点配置指导》](subsys-dfx-hisysevent-write-config.md)
\ No newline at end of file
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册