提交 c0cda040 编写于 作者: X xuyong

新增HiTrace JS API文档

Signed-off-by: Nxuyong <xuyong59@huawei.com>
上级 5965c23e
...@@ -15,7 +15,7 @@ SystemCapability.HiviewDFX.HiTrace ...@@ -15,7 +15,7 @@ SystemCapability.HiviewDFX.HiTrace
## HiTraceFlag ## HiTraceFlag
跟踪标志组合类型枚举 跟踪标志组合类型枚举
| 名称 | 默认值 | 说明 | | 名称 | 默认值 | 说明 |
| -------- | -------- | -------- | | -------- | -------- | -------- |
...@@ -30,7 +30,7 @@ SystemCapability.HiviewDFX.HiTrace ...@@ -30,7 +30,7 @@ SystemCapability.HiviewDFX.HiTrace
## HiTraceTracePointType ## HiTraceTracePointType
跟踪埋点类型枚举 跟踪埋点类型枚举
| 名称 | 默认值 | 说明 | | 名称 | 默认值 | 说明 |
| -------- | -------- | -------- | | -------- | -------- | -------- |
...@@ -42,7 +42,7 @@ SystemCapability.HiviewDFX.HiTrace ...@@ -42,7 +42,7 @@ SystemCapability.HiviewDFX.HiTrace
## HiTraceCommunicationMode ## HiTraceCommunicationMode
跟踪通信类型枚举 跟踪通信类型枚举
| 名称 | 默认值 | 说明 | | 名称 | 默认值 | 说明 |
| -------- | -------- | -------- | | -------- | -------- | -------- |
...@@ -53,7 +53,7 @@ SystemCapability.HiviewDFX.HiTrace ...@@ -53,7 +53,7 @@ SystemCapability.HiviewDFX.HiTrace
## HiTraceId ## HiTraceId
此接口为HiTraceId对象接口 此接口为HiTraceId对象接口
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
| -------- | -------- | -------- | -------- | | -------- | -------- | -------- | -------- |
...@@ -66,7 +66,7 @@ SystemCapability.HiviewDFX.HiTrace ...@@ -66,7 +66,7 @@ SystemCapability.HiviewDFX.HiTrace
begin(name: string, flags: number = HiTraceFlag.DEFAULT): HiTraceId begin(name: string, flags: number = HiTraceFlag.DEFAULT): HiTraceId
跟踪开始同步接口 跟踪开始同步接口
- 参数: - 参数:
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -87,7 +87,7 @@ begin(name: string, flags: number = HiTraceFlag.DEFAULT): HiTraceId ...@@ -87,7 +87,7 @@ begin(name: string, flags: number = HiTraceFlag.DEFAULT): HiTraceId
end(id: HiTraceId): void end(id: HiTraceId): void
跟踪结束同步接口 跟踪结束同步接口
- 参数: - 参数:
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -105,7 +105,7 @@ end(id: HiTraceId): void ...@@ -105,7 +105,7 @@ end(id: HiTraceId): void
getId(): HiTraceId getId(): HiTraceId
获取跟踪标识同步接口 获取跟踪标识同步接口
- 返回值: - 返回值:
| 类型 | 说明 | | 类型 | 说明 |
...@@ -124,7 +124,7 @@ getId(): HiTraceId ...@@ -124,7 +124,7 @@ getId(): HiTraceId
setId(id: HiTraceId): void setId(id: HiTraceId): void
设置跟踪标识同步接口 设置跟踪标识同步接口
- 参数: - 参数:
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -143,7 +143,7 @@ setId(id: HiTraceId): void ...@@ -143,7 +143,7 @@ setId(id: HiTraceId): void
clearId(): void clearId(): void
清除跟踪标识同步接口 清除跟踪标识同步接口
- 示例: - 示例:
``` ```
...@@ -157,7 +157,7 @@ clearId(): void ...@@ -157,7 +157,7 @@ clearId(): void
createSpan(): HiTraceId createSpan(): HiTraceId
创建跟踪分支同步接口 创建跟踪分支同步接口
- 返回值: - 返回值:
| 类型 | 说明 | | 类型 | 说明 |
...@@ -176,7 +176,7 @@ createSpan(): HiTraceId ...@@ -176,7 +176,7 @@ createSpan(): HiTraceId
tracepoint(mode: HiTraceCommunicationMode, type: HiTraceTracePointType, id: HiTraceId, msg?: string): void tracepoint(mode: HiTraceCommunicationMode, type: HiTraceTracePointType, id: HiTraceId, msg?: string): void
信息埋点同步接口 信息埋点同步接口
- 参数: - 参数:
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -197,7 +197,7 @@ tracepoint(mode: HiTraceCommunicationMode, type: HiTraceTracePointType, id: HiTr ...@@ -197,7 +197,7 @@ tracepoint(mode: HiTraceCommunicationMode, type: HiTraceTracePointType, id: HiTr
isValid(id: HiTraceId): boolean isValid(id: HiTraceId): boolean
判断HiTraceId对象是否有效同步接口 判断HiTraceId对象是否有效同步接口
- 参数: - 参数:
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -219,7 +219,7 @@ isValid(id: HiTraceId): boolean ...@@ -219,7 +219,7 @@ isValid(id: HiTraceId): boolean
isFlagEnabled(id: HiTraceId, flag: HiTraceFlag): boolean isFlagEnabled(id: HiTraceId, flag: HiTraceFlag): boolean
判断HiTraceId对象中指定的跟踪标志是否置位同步接口 判断HiTraceId对象中指定的跟踪标志是否置位同步接口
- 参数: - 参数:
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
...@@ -239,7 +239,7 @@ isFlagEnabled(id: HiTraceId, flag: HiTraceFlag): boolean ...@@ -239,7 +239,7 @@ isFlagEnabled(id: HiTraceId, flag: HiTraceFlag): boolean
enableFlag(id: HiTraceId, flag: HiTraceFlag): void enableFlag(id: HiTraceId, flag: HiTraceFlag): void
置位HiTraceId对象中指定的跟踪标志同步接口 置位HiTraceId对象中指定的跟踪标志同步接口
- 参数: - 参数:
| 参数名 | 类型 | 必填 | 说明 | | 参数名 | 类型 | 必填 | 说明 |
......
Markdown is supported
0% .
You are about to add 0 people to the discussion. Proceed with caution.
先完成此消息的编辑!
想要评论请 注册