From a9d75d826ff380e6bf001443e0980d04bc9541dd Mon Sep 17 00:00:00 2001
From: xuyong <xuyong59@huawei.com>
Date: Thu, 27 Jan 2022 18:46:13 +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 <xuyong59@huawei.com>
---
 .../subsystems/subsys-dfx-hisysevent-tool.md  | 106 +++++++++++-------
 1 file changed, 66 insertions(+), 40 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 b90bfc56b0..f3fd70ebf1 100644
--- a/zh-cn/device-dev/subsystems/subsys-dfx-hisysevent-tool.md
+++ b/zh-cn/device-dev/subsystems/subsys-dfx-hisysevent-tool.md
@@ -1,64 +1,90 @@
 # HiSysEvent工具使用指导<a name="ZH-CN_TOPIC_0000001231614021"></a>
 
 -   [概述](#section1886702718521)
--   [使用指导](#section1210623418527)
+-   [订阅实时HiSysEvent事件相关命令](#section1210623418527)
+-   [查询历史HiSysEvent事件相关命令](#section1210623418539)
 
 ## 概述<a name="section1886702718521"></a>
 
-目前系统预置了HiSysEvent小工具，可以通过命令行参数，设置查询条件，查询满足要求的HiSysEvent系统事件，支撑开发者在开发过程中追踪系统事件打点结果，及故障定位时系统所发生的事件等。
+目前在系统的/system/bin目录下预置了hisysevent工具，开发者可以通过此工具订阅实时系统事件及查询历史HiSysEvent事件。
 
-## 使用指导<a name="section1210623418527"></a>
+## 订阅实时HiSysEvent事件相关命令<a name="section1210623418527"></a>
 
-1.  HiSysEvent工具的参数：
+1. 实时订阅HiSysEvent事件的基础命令：
 
-    工具预置在/system/bin目录下，命令可以在任意目录执行。
+**hisysevent -r**
 
-    ```
-    hisysevent [-r [-d | -c [WHOLE_WORD|PREFIX|REGULAR] -t <tag> | -c [WHOLE_WORD|PREFIX|REGULAR] -o <domain> -n <eventName> ]
-        | -l [-s <time> -e <time> -m <count>]]
-    -r    subscribe on empty domain, eventname and tag
-    -r -c [WHOLE_WORD|PREFIX|REGULAR] -t <tag>, subscribe on tag
-    -r -c [WHOLE_WORD|PREFIX|REGULAR] -o <domain> -n <eventName>, subscribe on domain and event name
-    -r -d set debug mode, both options must appear at the same time.
-    -l -s <begin time> -e <end time> -m <max hisysevent count>
-        get history hisysevent log, begin time should not be earlier than end time.
-    ```
+options选项说明：
 
-2.  订阅实时HiSysEvent事件的命令：
+| 选项名称 | 功能说明  |
+| -------- | --------- |
+| -r       | 以缺省设置实时订阅HiSysEvent事件，在此种订阅方式下有任何实时HiSysEvent事件产生，都会在控制台上打印此HiSysEvent事件 | 
 
-    ```
-    hisysevent -r
-    ```
+2. 打开调试模式：
 
-    当有实时HiSysEvent事件发生，会在控制台上打印该HiSysEvent事件。
+**hisysevent -r -d**
 
-    ```
-    hisysevent -r -c [WHOLE_WORD|PREFIX|REGULAR] -t <tag>
-    ```
+options选项说明：
 
-    通过事件标签规则订阅实时HiSysEvent事件，当有与指定的事件标签以指定的匹配类型匹配的实时HiSysEvent事件发生，会在控制台上打印该HiSysEvent事件。<br>
-        -c用来指定匹配类型，包括“全词匹配”、“前缀匹配”以及“正则匹配”三种类型，如果没有-c，则默认使用全词匹配类型。<br>
-        -t用来指定事件标签，如果没有-t，则使用空字符串。<br>
+| 选项名称 | 功能说明  |
+| -------- | --------- |
+| -d       | 在调试模式下实时订阅HiSysEvent事件 | 
 
-	```
-    hisysevent -r -c [WHOLE_WORD|PREFIX|REGULAR] -o <domain> -n <eventName>
-    ```
+3. 通过事件标签方式订阅实时系统事件：
 
-    通过事件领域及事件名称规则订阅实时HiSysEvent事件，当有与指定的的事件领域及事件名称以指定的匹配类型匹配的实时HiSysEvent事件发生，会在控制台上打印该HiSysEvent事件。<br>
-        -c 用来指定匹配类型，包括“全词匹配”、“前缀匹配”以及“正则匹配”三种类型，如果没有-c，则默认使用全词匹配类型。<br>
-        -o 用来指定事件领域，如果没有-o，则使用空字符串。<br>
-        -n 用来指定事件名称，如果没有-n，则使用空字符串。
+**hisysevnet -r -t \<tag\> \[-c \[WHOLE_WORD|PREFIX|REGULAR\]\]**
 
-    当同时通过-t、-o及-n指定了相关订阅规则参数设置，则判断设置的事件标签是否为空，若不为空，则使用事件标签规则进行订阅，否则使用事件领域及事件名称订阅规则进行订阅。
+options选项说明：
 
-3.  查询历史HiSysEvent事件的命令：
+| 选项名称 | 功能说明  |
+| -------- | --------- |
+| -t       | 设置实时订阅的HiSysEvent事件标签，用来过滤订阅的HiSysEvent事件 |
+| -c       | 设置实时订阅的HiSysEvent事件标签匹配规则，有“WHOLE_WORD”、“PREFIX”、“REGULAR”三种匹配规则|
 
-    ```
-    hisysevent -l -s <begin time> -e <end time> -m <max hisysevent count>
-    ```
+4. 通过事件领域及事件名称的方式订阅实时系统事件：
 
-    其中-s和-e分别指定了事件生成的开始时间和结束时间，如果没有-s或者-e，代表查询时间无限制。
+**hisysevent -r -o \<domain\> -n \<eventName\> \[-c \[WHOLE_WORD|PREFIX|REGULAR\]\]**
 
-    -m参数指定了本次查询返回的HiSysEvent事件的最多条数。
+| 选项名称 | 功能说明  |
+| -------- | --------- |
+| -o       | 设置实时订阅的HiSysEvent事件领域，用来过滤订阅的HiSysEvent事件 |
+| -n       | 设置实时订阅的HiSysEvent事件名称，用来过滤订阅的HiSysEvent事件|
+| -c       | 设置实时订阅的HiSysEvent事件领域及事件名称的匹配规则，有“WHOLE_WORD”、“PREFIX”、“REGULAR”三种匹配规则|
 
+>![](../public_sys-resources/icon-note.gif) **说明：** 
+>当同时通过-t、-o及-n指定了相关订阅规则参数设置，则判断设置的事件标签是否为空，若不为空，则使用事件标签规则进行订阅，否则使用事件领域及事件名称订阅规则进行订阅。
 
+    
+
+## 查询历史HiSysEvent事件相关命令<a name="section1210623418539"></a>
+
+1. 查询历史HiSysEvent事件的基础命令：
+
+**hisysevent -l**
+
+options选项说明：
+
+| 选项名称 | 功能说明  |
+| -------- | --------- |
+| -l       | 以缺省设置查询历史HiSysEvent事件，此次查询会返回所有落盘的HiSysEvent事件 | 
+
+2. 通过设置开始/结束时间，过滤查询历史HiSysEvent事件的结果的命令：
+
+**hisysevent -l -s \<begin time\> -e \<end time\>**
+
+options选项说明：
+
+| 选项名称 | 功能说明  |
+| -------- | --------- |
+| -s       | 设置查询历史HiSysEvent事件的开始时间，此次查询只会返回不早于该时间点的HiSysEvent事件 |
+| -e       | 设置查询历史HiSysEvent事件的结束时间，此次查询只会返回不晚于该时间点的HiSysEvent事件 |
+
+3. 通过设置最大数量值，限制查询历史HiSysEvent事件的数量：
+
+**hisysevent -l -m \<max hisysevent count\>**
+
+options选项说明：
+
+| 选项名称 | 功能说明  |
+| -------- | --------- |
+| -m       | 设置查询历史HiSysEvent事件的数量，此次查询返回的HiSysEvent事件数目不会多于此值 |
\ No newline at end of file
-- 
GitLab