!16301 【3.2release挑单】hisysevent及hitracechain开发指南规范性及易用性整改

Merge pull request !16301 from honghecun/cherry-pick-1679356828

en/device-dev/subsystems/subsys-dfx-hisysevent-logging-config.md

@@ -6,18 +6,18 @@
 
 ### Function Introduction
 
-If HiSysEvent logging is required for a component, you need to define a YAML file and [configure the YAML file path](#configuring-the-yaml-file-path) in the **bundle.json** file. During compilation, the OpenHarmony compilation framework will use the Python compilation script to parse and verify all the YAML files configured in the **bundle.json** file. On completion, the compilation framework will summarize the configuration information in the YAML files and convert the information into a JSON file named **hisysevent.def**. After that, the compilation framework will put the JSON file to a specified path as the basis for the system to determine whether to log system events.
+If HiSysEvent logging is required for a component, you need to define a YAML file and [configure the YAML file path](#verifying-the-yaml-file) in the **bundle.json** file. During compilation, the OpenHarmony compilation framework will use the Python compilation script to parse and verify all the YAML files configured in the **bundle.json** file. On completion, the compilation framework will summarize the configuration information in the YAML files and convert the information into a JSON file named **hisysevent.def**. After that, the compilation framework will put the JSON file to a specified path as the basis for the system to determine whether to log system events.
 
 
 ### Basic Concepts
 
 Understanding the following concepts would be helpful for you in configuring HiSysEvent logging.
 
-- Event domain<br>Represents the domain to which an event belongs. It is specified by the **domain** field in the YAML file. For details, see [domain](#example) in the example YAML file.
+- Event domain<br>Represents the domain to which an event belongs. It is specified by the **domain** field in the YAML file. For details, see [domain](#writing-a-yaml-file) in the example YAML file.
 
-- Event name<br>Indicates the events in an event domain. For details, see [EVENT\_NAMEA/EVENT\_NAMEB](#example) in the example YAML file.
+- Event name<br>Indicates the events in an event domain. For details, see [EVENT\_NAMEA/EVENT\_NAMEB](#writing-a-yaml-file) in the example YAML file.
 
-- Parameter<br>Defines the key values in an event name. For details, see [__BASE/NAME1/NAME2](#example) in the example YAML file.
+- Parameter<br>Defines the key values in an event name. For details, see [__BASE/NAME1/NAME2](#writing-a-yaml-file) in the example YAML file.
 
 
 ### Constraints
@@ -47,11 +47,12 @@ Constraints on the event domain, event name, and parameter
   | arrsize | Length of the parameter of the array type. This field is optional.<br>Value:<br>1-100|
   | desc | Parameter description. This field is mandatory.<br>Rule:<br>The description contains 3 to 128 characters, including a to z, A to Z, 0 to 9, and underscores (_).|
 
+## How to Develop
 
-## Writing a YAML File
+### Writing a YAML File
 
 
-### Writing Rules
+**Writing Rules**
 
 - Event domain naming rules:
   - The name must start with a letter and can contain only uppercase letters, digits, and underscores (&#95;).
@@ -68,7 +69,7 @@ Constraints on the event domain, event name, and parameter
   - The number of parameters in an event domain cannot exceed 128.
 
 
-### Example
+**Example**
 
 - In the example YAML file, the event domain name is **MODULEA**. The event domain contains two events named **EVENT_NAMEA** and **EVENT_NAMEB**.
 
@@ -96,10 +97,10 @@ Constraints on the event domain, event name, and parameter
   ```
 
 
-## Verifying the YAML File
+### Verifying the YAML File
 
 
-### Configuring the YAML File Path
+**Configuring the YAML File Path**
 
 In the **bundle.json** file, use the **hisysevent_config** attribute to specify the YAML file path.
 
@@ -150,7 +151,7 @@ In the **bundle.json** file, use the **hisysevent_config** attribute to specify
 > The YAML file can be placed in any directory of the component project as needed. You only need to specify the path in the **bundle.json** file.
 
 
-### Compiling YAML Files
+**Compiling YAML Files**
 
 - Perform full compilation.
   - During full compilation of the system, the configurations in the YAML files of all components are summarized. After the compilation is complete, the **hisysevent.def** file will be generated in the specified directory.

zh-cn/device-dev/subsystems/subsys-dfx-hisysevent-logging-config.md

@@ -6,18 +6,18 @@
 
 ### 功能简介
 
-组件若有HiSysEvent事件的打点需求，则需要先定义yaml文件并在bundle.json文件中[配置yaml文件的路径](subsys-dfx-hisysevent-logging-config.md#配置yaml文件路径)。OpenHarmony编译框架在编译过程中则会通过python编译脚本解析校验bundle.json文件指定的所有yaml文件。在解析校验之后，编译框架会将这些yaml文件中配置的信息汇总转换成名为hisysevent.def的json文件。最后，将此json文件打包到系统指定路径下，用作HiSysEvent事件落盘的判断依据。
+组件若有HiSysEvent事件的打点需求，则需要先定义yaml文件并在bundle.json文件中[配置yaml文件的路径](subsys-dfx-hisysevent-logging-config.md#验证yaml文件)。OpenHarmony编译框架在编译过程中则会通过python编译脚本解析校验bundle.json文件指定的所有yaml文件。在解析校验之后，编译框架会将这些yaml文件中配置的信息汇总转换成名为hisysevent.def的json文件。最后，将此json文件打包到系统指定路径下，用作HiSysEvent事件落盘的判断依据。
 
 
 ### 基本概念
 
 在配置HiSysEvent打点之前，开发者应了解以下基本概念：
 
-- 事件领域 用于标识事件所属的领域，在yaml文件中以domain为键值指定，可参考yaml文件样例中的[domain](subsys-dfx-hisysevent-logging-config.md#编写样例)。
+- 事件领域 用于标识事件所属的领域，在yaml文件中以domain为键值指定，可参考yaml文件样例中的[domain](subsys-dfx-hisysevent-logging-config.md#编写yaml文件)。
 
-- 事件名称 用于指定事件领域包含的所有事件，可参考yaml文件样例中的[EVENT_NAMEA/EVENT_NAMEB](subsys-dfx-hisysevent-logging-config.md#编写样例)。
+- 事件名称 用于指定事件领域包含的所有事件，可参考yaml文件样例中的[EVENT_NAMEA/EVENT_NAMEB](subsys-dfx-hisysevent-logging-config.md#编写yaml文件)。
 
-- 参数 用于定义某个事件名称包含的所有键值，可参考yaml文件样例中的[__BASE/NAME1/NAME2](subsys-dfx-hisysevent-logging-config.md#编写样例)。
+- 参数 用于定义某个事件名称包含的所有键值，可参考yaml文件样例中的[__BASE/NAME1/NAME2](subsys-dfx-hisysevent-logging-config.md#编写yaml文件)。
 
 
 ### 约束与限制
@@ -47,10 +47,13 @@
   | desc | 字段作用：必选字段，用来对该参数进行描述。<br/>定义规则：<br/>-&nbsp;至少包含3个字符，最多包含128个字符，字符范围[a-zA-Z0-9&nbsp;_] |
 
 
-## 编写yaml文件
+## 开发步骤
 
 
-### 编写规则
+### 编写yaml文件
+
+
+**编写规则**
 
 - 事件领域命名规则：
   - 字母开头，且只能由大写字母/数字/下划线组成；
@@ -67,7 +70,7 @@
   - 单个事件名称内包含的参数的个数不能超过128个。
 
 
-### 编写样例
+**编写样例**
 
 - yaml文件样例指定的事件领域名称为MODULEA，该事件领域包含两个事件，名称分别是EVENT_NAMEA和EVENT_NAMEB。
 
@@ -95,10 +98,10 @@
   ```
 
 
-## 验证yaml文件
+### 验证yaml文件
 
 
-### 配置yaml文件路径
+**配置yaml文件路径**
 
 在bundle.json文件中通过hisysevent_config属性完成yaml文件的路径指定：
 
@@ -149,7 +152,7 @@
 > yaml文件可根据实际需求置于组件工程的任意目录下，只要在bundle.json文件指定即可。
 
 
-### 编译yaml文件
+**编译yaml文件**
 
 - 全量编译：
   - 全量编译整个系统，会将所有组件配置的yaml文件中的配置进行汇总，正常完成系统编译后，指定目录下就会生成hisysevent.def文件。

zh-cn/device-dev/subsystems/subsys-dfx-hisysevent-overview.md

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

zh-cn/device-dev/subsystems/subsys-dfx-hitracechain.md

@@ -51,58 +51,90 @@ HiTraceChain实现在C层，主要原理是在一次业务调用流程中，利
 |  | **C++** | **C** |
 | -------- | -------- | -------- |
 | **类** | **函数** | **函数** |
-| HiTraceChain | HiTraceId Begin(const std::string& name, int flags) | HiTraceIdStruct HiTraceChainBegin(const char\* name, int flags) |
-|  | void End(const HiTraceId& id) | void HiTraceChainEnd(const HiTraceIdStruct\* pId) |
-|  | HiTraceId GetId(); | HiTraceIdStruct HiTraceChainGetId() |
-|  | void SetId(const HiTraceId& id) | void HiTraceChainSetId(const HiTraceIdStruct\* pId) |
-|  | void ClearId() | void HiTraceChainClearId() |
-|  | HiTraceId CreateSpan() | HiTraceIdStruct HiTraceChainCreateSpan() |
-|  | void Tracepoint(HiTraceTracepointType type, const HiTraceId& id, const char\* fmt, ...) | void HiTraceChainTracepoint(HiTraceTracepointType type, const HiTraceIdStruct_ pId, const char_ fmt, ...) |
-|  | void Tracepoint(HiTraceCommunicationMode mode, HiTraceTracepointType type, const HiTraceId& id, const char\* fmt, ...) | void HiTraceChainTracepointEx(HiTraceCommunicationMode mode, HiTraceTracepointType type, const HiTraceIdStruct_ pId, const char_ fmt, ...) |
-| HiTraceId | HiTraceId(); | void HiTraceChainInitId(HiTraceIdStruct\* pId) |
-|  | HiTraceId(const uint8_t\* pIdArray, int len) | HiTraceIdStruct HiTraceChainBytesToId(const uint8_t\* pIdArray, int len) |
-|  | bool IsValid() | int HiTraceChainIsValid(const HiTraceIdStruct\* pId) |
-|  | bool IsFlagEnabled(HiTraceFlag flag) | int HiTraceChainIsFlagEnabled(const HiTraceIdStruct\* pId, HiTraceFlag flag) |
-|  | void EnableFlag(HiTraceFlag flag) | void HiTraceChainEnableFlag(HiTraceIdStruct\* pId, HiTraceFlag flag) |
-|  | int GetFlags() | int HiTraceChainGetFlags(const HiTraceIdStruct\* pId) |
-|  | void SetFlags(int flags) | void HiTraceChainSetFlags(HiTraceIdStruct\* pId, int flags) |
-|  | uint64_t GetChainId() | uint64_t HiTraceChainGetChainId(const HiTraceIdStruct\* pId) |
-|  | void SetChainId(uint64_t chainId) | void HiTraceChainSetChainId(HiTraceIdStruct\* pId, uint64_t chainId) |
-|  | uint64_t GetSpanId() | uint64_t HiTraceChainGetSpanId(const HiTraceIdStruct\* pId) |
-|  | void SetSpanId(uint64_t spanId) | void HiTraceChainSetSpanId(HiTraceIdStruct\* pId, uint64_t spanId) |
-|  | uint64_t GetParentSpanId() | uint64_t HiTraceChainGetParentSpanId(const HiTraceIdStruct\* pId) |
-|  | void SetParentSpanId(uint64_t parentSpanId) | void HiTraceChainSetParentSpanId(HiTraceIdStruct\* pId, uint64_t parentSpanId) |
-|  | int ToBytes(uint8_t\* pIdArray, int len) | int HiTraceChainIdToBytes(const HiTraceIdStruct_ pId, uint8_t_ pIdArray, int len) |
+| HiTraceChain | HiTraceId Begin(const std::string& name, int flags) | HiTraceIdStruct HiTraceChainBegin(const char* name, int flags) |
+|  | void End(const HiTraceId& id) | void HiTraceChainEnd(const HiTraceIdStruct* pId) |
+|  | HiTraceId GetId(); | HiTraceIdStruct HiTraceChainGetId() |
+|  | void SetId(const HiTraceId& id) | void HiTraceChainSetId(const HiTraceIdStruct* pId) |
+|  | void ClearId() | void HiTraceChainClearId() |
+|  | HiTraceId CreateSpan() | HiTraceIdStruct HiTraceChainCreateSpan() |
+|  | void Tracepoint(HiTraceTracepointType type, const HiTraceId& id, const char* fmt, ...) | void HiTraceChainTracepoint(HiTraceTracepointType type, const HiTraceIdStruct* pId, const char* fmt, ...) |
+|  | void Tracepoint(HiTraceCommunicationMode mode, HiTraceTracepointType type, const HiTraceId& id, const char* fmt, ...) | void HiTraceChainTracepointEx(HiTraceCommunicationMode mode, HiTraceTracepointType type, const HiTraceIdStruct* pId, const char* fmt, ...) |
+| HiTraceId | HiTraceId(); | void HiTraceChainInitId(HiTraceIdStruct* pId) |
+|  | HiTraceId(const uint8_t* pIdArray, int len) | HiTraceIdStruct HiTraceChainBytesToId(const uint8_t* pIdArray, int len) |
+|  | bool IsValid() | int HiTraceChainIsValid(const HiTraceIdStruct* pId) |
+|  | bool IsFlagEnabled(HiTraceFlag flag) | int HiTraceChainIsFlagEnabled(const HiTraceIdStruct* pId, HiTraceFlag flag) |
+|  | void EnableFlag(HiTraceFlag flag) | void HiTraceChainEnableFlag(HiTraceIdStruct* pId, HiTraceFlag flag) |
+|  | int GetFlags() | int HiTraceChainGetFlags(const HiTraceIdStruct* pId) |
+|  | void SetFlags(int flags) | void HiTraceChainSetFlags(HiTraceIdStruct* pId, int flags) |
+|  | uint64_t GetChainId() | uint64_t HiTraceChainGetChainId(const HiTraceIdStruct* pId) |
+|  | void SetChainId(uint64_t chainId) | void HiTraceChainSetChainId(HiTraceIdStruct* pId, uint64_t chainId) |
+|  | uint64_t GetSpanId() | uint64_t HiTraceChainGetSpanId(const HiTraceIdStruct* pId) |
+|  | void SetSpanId(uint64_t spanId) | void HiTraceChainSetSpanId(HiTraceIdStruct* pId, uint64_t spanId) |
+|  | uint64_t GetParentSpanId() | uint64_t HiTraceChainGetParentSpanId(const HiTraceIdStruct* pId) |
+|  | void SetParentSpanId(uint64_t parentSpanId) | void HiTraceChainSetParentSpanId(HiTraceIdStruct* pId, uint64_t parentSpanId) |
+|  | int ToBytes(uint8_t* pIdArray, int len) | int HiTraceChainIdToBytes(const HiTraceIdStruct_ pId, uint8_t* pIdArray, int len) |
 
 
 ### 接口功能参数
 
-  **表2** C++接口说明函数参数和功能
+  **表2** 跟踪标志组合类型枚举
+
+| **名称** | **值** | **说明** |
+| -------- | -------- | -------- |
+| HITRACE_FLAG_DEFAULT           | 0      | 缺省标志。       |
+| HITRACE_FLAG_INCLUDE_ASYNC | 1      | 异步调用标志。启动跟踪时，缺省只跟踪同步调用。设置该标志，同时跟踪同步、异步调用。   |
+| HITRACE_FLAG_DONOT_CREATE_SPAN | 1 << 1 | 无分支标志。启动跟踪时，在同步、异步调用时缺省自动创建分支信息。设置该标志，指示不创建分支。     |
+| HITRACE_FLAG_TP_INFO           | 1 << 2 | 埋点标志。启动跟踪式时，缺省不进行埋点。调试场景下设置该标志，在同步、异步调用的收发侧自动埋点，输出埋点信息和时间戳。收发埋点按照client、server分为client send（CS）、server receive（SR）、server send（SS）、client receive（CR）四类信息。一次同步调用输出CS/SR/SS/CR，一次异步调用输出CS/SR/SS三个埋点信息。       |
+| HITRACE_FLAG_NO_BE_INFO        | 1 << 3 | 无起始结束标志。启动跟踪时，缺省打印启动及结束跟踪信息。设置该标志，指示不打印启动及结束跟踪信息。 |
+| HITRACE_FLAG_DONOT_ENABLE_LOG       | 1 << 4 | 日志关联标志。设置该标志，指示隐藏日志中的跟踪信息。  |
+| HITRACE_FLAG_FAULT_TRIGGER   | 1 << 5 | 故障触发标志。预置标志，暂时没有作用。  |
+| HITRACE_FLAG_D2D_TP_INFO       | 1 << 6 | 设备间埋点标志。TP_INFO的一个子集，设置该标志，只进行设备间的调用埋点。 |
+
+  **表3** 跟踪埋点类型枚举
+
+| **名称** | **值** | **说明** |
+| -------- | -------- | -------- |
+| HITRACE_TP_CS       | 0 | 客户端发送类型，标识client侧的发送埋点。        |
+| HITRACE_TP_CR       | 1 | 客户端接收类型，标识client侧的接收埋点。        |
+| HITRACE_TP_SS       | 2 | 服务端发送类型，标识server侧的发送埋点。        |
+| HITRACE_TP_SR       | 3 | 服务端接收类型，标识server侧的接收埋点。        |
+| HITRACE_TP_GENERAL  | 4 | 一般类型，标识CS、CR、SS、SR四种场景之外的埋点。|
+
+  **表4** 跟踪通信类型枚举
+
+| **名称** | **值** | **说明** |
+| -------- | -------- | -------- |
+| HITRACE_CM_DEFAULT  | 0 | 缺省通信类型    |
+| HITRACE_CM_THREAD   | 1 | 线程间通信类型  |
+| HITRACE_CM_PROCESS  | 2 | 进程间通信类型  |
+| HITRACE_CM_DEVICE   | 3 | 设备间通信类型  |
+
+  **表5** C++接口说明函数参数和功能
 
 | **类** | **方法** | **描述** |
 | -------- | -------- | -------- |
-| HiTraceChain | HiTraceId&nbsp;Begin(const&nbsp;std::string&amp;&nbsp;name,&nbsp;int&nbsp;flags) | 功能：启动HiTraceChain跟踪、生成HiTraceId对象并设置到当前线程TLS中。<br/>输入参数：<br/>-&nbsp;name：业务流程名称。<br/>-&nbsp;flags：跟踪指示位，可以组合使用，具体含义为：<br/>&nbsp;&nbsp;-&nbsp;HITRACE_FLAG_INCLUDE_ASYNC：同时跟踪同步调用和异步调用，缺省只跟踪同步调用。<br/>&nbsp;&nbsp;-&nbsp;HITRACE_FLAG_DONOT_CREATE_SPAN：不创建子分支，缺省创建子分支。<br/>&nbsp;&nbsp;-&nbsp;HITRACE_FLAG_TP_INFO：输出tracepoint信息，缺省不输出。<br/>&nbsp;&nbsp;-&nbsp;HITRACE_FLAG_NO_BE_INFO：不输出起始、结束信息，缺省输出。<br/>&nbsp;&nbsp;-&nbsp;HITRACE_FLAG_DONOT_ENABLE_LOG：不与日志关联输出，缺省关联。<br/>&nbsp;&nbsp;-&nbsp;HITRACE_FLAG_FAULT_TRIGGER：故障触发的跟踪，缺省为正常启动的。<br/>&nbsp;&nbsp;-&nbsp;HITRACE_FLAG_D2D_TP_INFO：输出设备间tracepoint信息，缺省不输出。<br/>&nbsp;&nbsp;-&nbsp;HITRACE_FLAG_DEFAULT:&nbsp;缺省标志。<br/>-&nbsp;输出参数：无<br/>-&nbsp;返回值：启动跟踪超过返回有效HiTraceId对象，否则返回无效对象。<br/>注意：嵌套启动跟踪时，内层启动调用返回无效对象。 |
-|  | void&nbsp;End(const&nbsp;HiTraceId&amp;&nbsp;id) | 功能：根据Begin返回的HiTraceId停止HiTraceChain跟踪；清除当前线程TLS中HiTraceId内容。<br/>输入参数：<br/>-&nbsp;id：HiTraceId对象。<br/>输出参数：无。<br/>返回值：无。 |
-|  | HiTraceId&nbsp;GetId(); | 功能：从当前线程TLS中获取HiTraceId对象。<br/>输入参数：无。<br/>输出参数：无。<br/>返回值：当前线程上下文的HiTraceId对象。 |
-|  | void&nbsp;SetId(const&nbsp;HiTraceId&amp;&nbsp;id) | 功能：设置HiTraceId对象内容到当前线程TLS中。<br/>输入参数：<br/>-&nbsp;id：HiTraceId对象。<br/>输出参数：无。<br/>返回值：无。 |
-|  | void&nbsp;ClearId() | 功能：清除当前线程TLS中的HiTraceId对象。<br/>输入参数：无。<br/>输出参数：无。<br/>返回值：无。 |
-|  | HiTraceId&nbsp;CreateSpan() | 接口功能：获取当前HiTraceId对象中的分支ID。<br/>输入参数：无。<br/>输出参数：无。<br/>返回值：当前分支ID。 |
-|  | void&nbsp;Tracepoint(HiTraceTracepointType&nbsp;type,&nbsp;const&nbsp;HiTraceId&amp;&nbsp;id,&nbsp;const&nbsp;char\*&nbsp;fmt,&nbsp;...) | 功能：根据埋点信息类型输出HiTraceChain埋点信息，包括时间戳、子分支HiTraceId对象信息。<br/>输入参数：<br/>-&nbsp;type：埋点信息类型，具体为<br/>&nbsp;&nbsp;-&nbsp;HITRACE_TP_CS：Client&nbsp;Send，同步/异步通信客户端发送信息。<br/>&nbsp;&nbsp;-&nbsp;HITRACE_TP_SR：Server&nbsp;Receive，&nbsp;同步/异步通信服务端接收信息。<br/>&nbsp;&nbsp;-&nbsp;HITRACE_TP_SS：Server&nbsp;Send，同步通信服务端发送响应信息。<br/>&nbsp;&nbsp;-&nbsp;HITRACE_TP_CR：Client&nbsp;Receive，同步通信客户端接收响应信息。<br/>&nbsp;&nbsp;-&nbsp;HITRACE_TP_GENERAL：普通输出信息。<br/>-&nbsp;id：当前子分支id。<br/>-&nbsp;fmt：格式化变参描述字符串。<br/>-&nbsp;args：变参。<br/>输出参数：无。<br/>返回值：无。 |
-|  | void&nbsp;Tracepoint(HiTraceCommunicationMode&nbsp;mode,&nbsp;HiTraceTracepointType&nbsp;type,&nbsp;const&nbsp;HiTraceId&amp;&nbsp;id,&nbsp;const&nbsp;char\*&nbsp;fmt,&nbsp;...) | 功能：根据通信模式、埋点信息类型输出HiTraceChain埋点信息，包括时间戳、子分支HiTraceId对象信息。<br/>输入参数：<br/>-&nbsp;mode：通信模式，具体为<br/>&nbsp;&nbsp;-&nbsp;HITRACE_CM_DEFAULT：未指定通信模式。<br/>&nbsp;&nbsp;-&nbsp;HITRACE_CM_THREAD：线程间通信。<br/>&nbsp;&nbsp;-&nbsp;HITRACE_CM_PROCESS：进程间通信。<br/>&nbsp;&nbsp;-&nbsp;HITRACE_CM_DEVICE：设备间通信。<br/>-&nbsp;type：埋点信息类型，具体为<br/>&nbsp;&nbsp;-&nbsp;HITRACE_TP_CS：Client&nbsp;Send，同步/异步通信客户端发送信息。<br/>&nbsp;&nbsp;-&nbsp;HITRACE_TP_SR：Server&nbsp;Receive，&nbsp;同步/异步通信服务端接收信息。<br/>&nbsp;&nbsp;-&nbsp;HITRACE_TP_SS：Server&nbsp;Send，同步通信服务端发送响应信息。<br/>&nbsp;&nbsp;-&nbsp;HITRACE_TP_CR：Client&nbsp;Receive，同步通信客户端接收响应信息。<br/>&nbsp;&nbsp;-&nbsp;HITRACE_TP_GENERAL：普通输出信息。<br/>-&nbsp;id：当前子分支id。<br/>-&nbsp;fmt：格式化变参描述字符串。<br/>-&nbsp;args：变参。<br/>输出参数：无。<br/>返回值：无。 |
+| HiTraceChain | HiTraceId Begin(const std::string&amp; name, int flags) | 功能：启动HiTraceChain跟踪、生成HiTraceId对象并设置到当前线程TLS中。<br/>输入参数：<br/>- name：业务流程名称。<br/>- flags：跟踪指示位，可以组合使用，具体说明请参考**表2** 跟踪标志组合类型枚举。<br/>- 输出参数：无<br/>- 返回值：启动跟踪超过返回有效HiTraceId对象，否则返回无效对象。<br/>注意：嵌套启动跟踪时，内层启动调用返回无效对象。 |
+|  | void End(const HiTraceId&amp; id) | 功能：根据Begin返回的HiTraceId停止HiTraceChain跟踪；清除当前线程TLS中HiTraceId内容。<br/>输入参数：<br/>- id：HiTraceId对象。<br/>输出参数：无。<br/>返回值：无。 |
+|  | HiTraceId GetId(); | 功能：从当前线程TLS中获取HiTraceId对象。<br/>输入参数：无。<br/>输出参数：无。<br/>返回值：当前线程上下文的HiTraceId对象。 |
+|  | void SetId(const HiTraceId&amp; id) | 功能：设置HiTraceId对象内容到当前线程TLS中。<br/>输入参数：<br/>- id：HiTraceId对象。<br/>输出参数：无。<br/>返回值：无。 |
+|  | void ClearId() | 功能：清除当前线程TLS中的HiTraceId对象。<br/>输入参数：无。<br/>输出参数：无。<br/>返回值：无。 |
+|  | HiTraceId CreateSpan() | 接口功能：获取当前HiTraceId对象中的分支ID。<br/>输入参数：无。<br/>输出参数：无。<br/>返回值：当前分支ID。 |
+|  | void Tracepoint(HiTraceTracepointType type, const HiTraceId&amp; id, const char* fmt, ...) | 功能：根据埋点信息类型输出HiTraceChain埋点信息，包括时间戳、子分支HiTraceId对象信息。<br/>输入参数：<br/>- type：埋点信息类型，具体说明请参考**表3** 跟踪埋点类型枚举。<br/>- id：当前子分支id。<br/>- fmt：格式化变参描述字符串。<br/>- args：变参。<br/>输出参数：无。<br/>返回值：无。 |
+|  | void Tracepoint(HiTraceCommunicationMode mode, HiTraceTracepointType type, const HiTraceId&amp; id, const char* fmt, ...) | 功能：根据通信模式、埋点信息类型输出HiTraceChain埋点信息，包括时间戳、子分支HiTraceId对象信息。<br/>输入参数：<br/>- mode：通信模式，具体说明请参考**表4** 跟踪通信类型枚举。<br/>- type：埋点信息类型，具体说明请参考**表3** 跟踪埋点类型枚举。<br/>- id：当前子分支id。<br/>- fmt：格式化变参描述字符串。<br/>- args：变参。<br/>输出参数：无。<br/>返回值：无。 |
 | HiTraceId | HiTraceId(); | 功能：缺省构造函数，生成无效HiTraceId对象。<br/>输入参数：无。<br/>输出参数：无。<br/>返回值：无。 |
-|  | HiTraceId(const&nbsp;uint8_t\*&nbsp;pIdArray,&nbsp;int&nbsp;len) | 功能：构造函数，根据字节数组创建跟踪HiTraceId对象。<br/>输入参数：<br/>-&nbsp;pIdArray：字节数组指针。<br/>-&nbsp;len：字节数组长度。<br/>输出参数：无。<br/>返回值：无。 |
-|  | bool&nbsp;IsValid() | 功能：HiTraceId对象是否有效。<br/>输入参数：无。<br/>输出参数：无。<br/>返回值：true&nbsp;有效；false&nbsp;无效。 |
-|  | bool&nbsp;IsFlagEnabled(HiTraceFlag&nbsp;flag) | 功能：HiTraceId对象的某标志是否置位。<br/>输入参数：<br/>-&nbsp;flag：跟踪指示位，具体含义见Begin函数中的定义。<br/>输出参数：无。<br/>返回值：true&nbsp;该标志置位；false&nbsp;该标志未置位。 |
-|  | void&nbsp;EnableFlag(HiTraceFlag&nbsp;flag) | 功能：设置某跟踪标志位到HiTraceId对象中。<br/>输入参数：<br/>-&nbsp;flag：跟踪指示位，具体含义见Begin函数中的定义。<br/>输出参数：无。<br/>返回值：无。 |
-|  | int&nbsp;GetFlags() | 功能：获取HiTraceId对象中设置的标志位。<br/>输入参数：无。<br/>输出参数：无。<br/>返回值：跟踪指示位组合，具体含义见Begin函数中的定义。 |
-|  | void&nbsp;SetFlags(int&nbsp;flags) | 功能：设置跟踪标志位到HiTraceId对象中。<br/>输入参数：<br/>-&nbsp;flags：跟踪指示位组合，具体含义见Begin函数中的定义。<br/>输出参数：无。<br/>返回值：无。 |
-|  | uint64_t&nbsp;GetChainId() | 功能：获取跟踪链ID。<br/>输入参数：无。<br/>输出参数：无。<br/>返回值：跟踪链ID。 |
-|  | void&nbsp;SetChainId(uint64_t&nbsp;chainId) | 功能：设置跟踪链ID到HiTraceId对象中。<br/>输入参数：<br/>-&nbsp;chainId：跟踪链ID。<br/>输出参数：无。<br/>返回值：无。 |
-|  | uint64_t&nbsp;GetSpanId() | 接口功能：获取当前HiTraceId对象中的分支ID。<br/>输入参数：无。<br/>输出参数：无。<br/>返回值：当前分支ID。 |
-|  | void&nbsp;SetSpanId(uint64_t&nbsp;spanId) | 功能：设置分支ID到HiTraceId对象中。<br/>输入参数：<br/>-&nbsp;spanId：分支ID。<br/>输出参数：无。<br/>返回值：无。 |
-|  | uint64_t&nbsp;GetParentSpanId() | 功能：获取当前HiTraceId对象中的父分支ID。<br/>输入参数：无。<br/>输出参数：无。<br/>返回值：父分支ID。 |
-|  | void&nbsp;SetParentSpanId(uint64_t&nbsp;parentSpanId) | 功能：设置父分支ID到HiTraceId对象中。<br/>输入参数：<br/>-&nbsp;parentSpanId：父分支ID。<br/>输出参数：无。<br/>返回值：无。 |
-|  | int&nbsp;ToBytes(uint8_t\*&nbsp;pIdArray,&nbsp;int&nbsp;len) | 功能：将HiTraceId对象转换为字节数组，便于缓存或者通信传递。<br/>输入参数：<br/>-&nbsp;pIdArray：字节数组指针，数组长度至少为HITRACE_ID_LEN。<br/>-&nbsp;len:&nbsp;字节数组长度<br/>输出参数：<br/>-&nbsp;pIdArray：字节数组指针，对象有效时存储转换后的对象数据。<br/>返回值：0&nbsp;转换失败；&nbsp;&amp;gt;0&nbsp;有效对象转换数组长度。 |
+|  | HiTraceId(const uint8_t* pIdArray, int len) | 功能：构造函数，根据字节数组创建跟踪HiTraceId对象。<br/>输入参数：<br/>- pIdArray：字节数组指针。<br/>- len：字节数组长度。<br/>输出参数：无。<br/>返回值：无。 |
+|  | bool IsValid() | 功能：HiTraceId对象是否有效。<br/>输入参数：无。<br/>输出参数：无。<br/>返回值：true 有效；false 无效。 |
+|  | bool IsFlagEnabled(HiTraceFlag flag) | 功能：HiTraceId对象的某标志是否置位。<br/>输入参数：<br/>- flag：跟踪指示位，具体含义见Begin函数中的定义。<br/>输出参数：无。<br/>返回值：true 该标志置位；false 该标志未置位。 |
+|  | void EnableFlag(HiTraceFlag flag) | 功能：设置某跟踪标志位到HiTraceId对象中。<br/>输入参数：<br/>- flag：跟踪指示位，具体含义见Begin函数中的定义。<br/>输出参数：无。<br/>返回值：无。 |
+|  | int GetFlags() | 功能：获取HiTraceId对象中设置的标志位。<br/>输入参数：无。<br/>输出参数：无。<br/>返回值：跟踪指示位组合，具体含义见Begin函数中的定义。 |
+|  | void SetFlags(int flags) | 功能：设置跟踪标志位到HiTraceId对象中。<br/>输入参数：<br/>- flags：跟踪指示位组合，具体含义见Begin函数中的定义。<br/>输出参数：无。<br/>返回值：无。 |
+|  | uint64_t GetChainId() | 功能：获取跟踪链ID。<br/>输入参数：无。<br/>输出参数：无。<br/>返回值：跟踪链ID。 |
+|  | void SetChainId(uint64_t chainId) | 功能：设置跟踪链ID到HiTraceId对象中。<br/>输入参数：<br/>- chainId：跟踪链ID。<br/>输出参数：无。<br/>返回值：无。 |
+|  | uint64_t GetSpanId() | 接口功能：获取当前HiTraceId对象中的分支ID。<br/>输入参数：无。<br/>输出参数：无。<br/>返回值：当前分支ID。 |
+|  | void SetSpanId(uint64_t spanId) | 功能：设置分支ID到HiTraceId对象中。<br/>输入参数：<br/>- spanId：分支ID。<br/>输出参数：无。<br/>返回值：无。 |
+|  | uint64_t GetParentSpanId() | 功能：获取当前HiTraceId对象中的父分支ID。<br/>输入参数：无。<br/>输出参数：无。<br/>返回值：父分支ID。 |
+|  | void SetParentSpanId(uint64_t parentSpanId) | 功能：设置父分支ID到HiTraceId对象中。<br/>输入参数：<br/>- parentSpanId：父分支ID。<br/>输出参数：无。<br/>返回值：无。 |
+|  | int ToBytes(uint8_t* pIdArray, int len) | 功能：将HiTraceId对象转换为字节数组，便于缓存或者通信传递。<br/>输入参数：<br/>- pIdArray：字节数组指针，数组长度至少为HITRACE_ID_LEN。<br/>- len: 字节数组长度<br/>输出参数：<br/>- pIdArray：字节数组指针，对象有效时存储转换后的对象数据。<br/>返回值：0 转换失败； &amp;gt;0 有效对象转换数组长度。 |
 
 
 ## 通信调用处理

zh-cn/device-dev/subsystems/subsys-dfx-overview.md

@@ -7,16 +7,18 @@
 
 提供以下功能：
 
-- HiLog流水日志，轻量系统类设备（参考内存≥128KiB）、小型系统类设备（参考内存≥1MiB）、标准系统类设备（参考内存≥128MB）适用。
+- HiLog流水日志，标准系统类设备（参考内存≥128MB）适用。
+
+- HiLog_Lite轻量化流水日志，轻量系统类设备（参考内存≥128KiB）、小型系统类设备（参考内存≥1MiB）适用。
 
 - HiTraceChain分布式跟踪，标准系统类设备（参考内存≥128MiB）适用。
 
+- HiTraceMeter性能跟踪，标准系统类设备（参考内存≥128MiB）适用。
+
 - HiCollie卡死故障检测，标准系统类设备（参考内存≥128MiB）适用。
 
 - HiSysEvent系统事件埋点，标准系统类设备（参考内存≥128MiB）适用。
 
-- HiChecker缺陷扫描，标准系统类设备（参考内存≥128MB）适用。
-
 - HiDumper信息导出，标准系统类设备（参考内存≥128MB）适用。
 
 - Faultlogger崩溃故障检测，标准系统类设备（参考内存≥128MB）适用。