From 1bff52810e1bd4c2ca38dc7f9932dab2d99e4c22 Mon Sep 17 00:00:00 2001 From: xuyong Date: Wed, 9 Feb 2022 17:18:59 +0800 Subject: [PATCH 01/13] =?UTF-8?q?=E6=96=B0=E5=A2=9EHiTrace=20JS=20API?= =?UTF-8?q?=E6=96=87=E6=A1=A3?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: xuyong --- .../reference/apis/Readme-CN.md | 1 + .../reference/apis/js-apis-hitrace.md | 256 ++++++++++++++++++ 2 files changed, 257 insertions(+) create mode 100644 zh-cn/application-dev/reference/apis/js-apis-hitrace.md diff --git a/zh-cn/application-dev/reference/apis/Readme-CN.md b/zh-cn/application-dev/reference/apis/Readme-CN.md index ac35ccf1c55..647304ff3ba 100644 --- a/zh-cn/application-dev/reference/apis/Readme-CN.md +++ b/zh-cn/application-dev/reference/apis/Readme-CN.md @@ -68,6 +68,7 @@ - [应用打点](js-apis-hiappevent.md) - [性能打点](js-apis-bytrace.md) - [故障日志获取](js-apis-faultLogger.md) + - [分布式跟踪](js-apis-hitrace.md) - 语言基础类库 - [获取进程相关的信息](js-apis-process.md) - [URL字符串解析](js-apis-url.md) diff --git a/zh-cn/application-dev/reference/apis/js-apis-hitrace.md b/zh-cn/application-dev/reference/apis/js-apis-hitrace.md new file mode 100644 index 00000000000..71cd8b1eb56 --- /dev/null +++ b/zh-cn/application-dev/reference/apis/js-apis-hitrace.md @@ -0,0 +1,256 @@ +# 分布式跟踪 + +> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：** +> 本模块首批接口从API version 8开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 + +## 导入模块 + +``` +import hitrace from '@ohos.hitrace'; +``` + +## 权限 + +无 + +## hitrace.HiTraceFlag + +跟踪标志组合类型枚举 + +| 名称 | 默认值 | 说明 | +| -------- | -------- | -------- | +| DEFAULT | 0 | 缺省标志 | +| INCLUDE_ASYNC | 1 | 异步调用标志 | +| DONOT_CREATE_SPAN | 1 << 1 | 无分支标志 | +| TP_INFO | 1 << 2 | 埋点标志 | +| NO_BE_INFO | 1 << 3 | 无起始结束标志 | +| DONOT_ENABLE_LOG | 1 << 4 | 日志关联标志 | +| FAILURE_TRIGGER | 1 << 5 | 故障触发标志 | +| D2D_TP_INFO | 1 << 6 | 设备间埋点标志 | + +## hitrace.HiTraceTracePointType + +跟踪埋点类型枚举 + +| 名称 | 默认值 | 说明 | +| -------- | -------- | -------- | +| CS | 0 | 客户端发送类型 | +| CR | 1 | 客户端接收类型 | +| SS | 2 | 服务端发送类型 | +| SR | 3 | 服务端接收类型 | +| GENERAL | 4 | 常规类型 | + +## hitrace.HiTraceCommunicationMode + +跟踪通信类型枚举 + +| 名称 | 默认值 | 说明 | +| -------- | -------- | -------- | +| DEFAULT | 0 | 缺省方式 | +| THREAD | 1 | 线程间通信类型 | +| PROCESS | 2 | 进程间通信类型 | +| DEVICE | 3 | 设备间通信类型 | + +## hitrace.HiTraceId + +此接口为HiTraceId对象接口 + +| 参数名 | 类型 | 必填 | 说明 | +| -------- | -------- | -------- | -------- | +| chainId | bigint | 是 | 跟踪链标识。 | +| spandId | number | 否 | 分支标识。 | +| parentSpanId | number | 否 | 父分支标识。 | +| flags | number | 否 | 跟踪标志组合。 | + +## hitrace.begin + +begin(name: string, flags: number = HiTraceFlag.DEFAULT): HiTraceId + +跟踪开始同步接口 + +- 参数： + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | name | string | 是 | 跟踪业务名。 | + | flags | number | 是 | [跟踪标志组合](#hitracehitraceflag)。 | +- 返回值： + | 类型 | 说明 | + | -------- | -------- | + | [HiTraceId](#hitracehitraceid) | HiTraceId实例。 | + +- 示例： + ``` + let asyncTraceId = hitrace.begin("business", hitrace.HiTraceFlag.INCLUDE_ASYNC | hitrace.HiTraceFlag.DONOT_CREATE_SPAN); + ``` + +## hitrace.end + +end(id: HiTraceId): void + +跟踪结束同步接口 + +- 参数： + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | id | [HiTraceId](#hitracehitraceid) | 是 | HiTraceId实例。 | + +- 示例： + ``` + let asyncTraceId = hitrace.begin("business"); + ... + hitrace.end(asyncTraceId); + ``` + +## hitrace.getId + +getId(): HiTraceId + +获取跟踪标识同步接口 + +- 返回值： + | 类型 | 说明 | + | -------- | -------- | + | [HiTraceId](#hitracehitraceid) | HiTraceId实例。 | + +- 示例： + ``` + let traceId = hitrace.begin("business"); + ... + let curTraceId = hitrace.getId(); + ... + ``` + +## hitrace.setId + +setId(id: HiTraceId): void + +设置跟踪标识同步接口 + +- 参数： + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | id | [HiTraceId](#hitracehitraceid) | 是 | HiTraceId实例。 | + +- 示例： + ``` + let traceId = hitrace.begin("business"); + ... + hitrace.setId(asyncTraceId); + ... + ``` + +## hitrace.clearId + +clearId(): void + +清除跟踪标识同步接口 + +- 示例： + ``` + let traceId = hitrace.begin("business"); + ... + hitrace.clearId(); + ... + ``` + +## hitrace.createSpan + +createSpan(): HiTraceId + +创建跟踪分支同步接口 + +- 返回值： + | 类型 | 说明 | + | -------- | -------- | + | [HiTraceId](#hitracehitraceid) | HiTraceId实例。 | + +- 示例： + ``` + let traceId = hitrace.begin("business"); + ... + let spanTraceId = hitrace.createSpan(); + ... + ``` + +## hitrace.tracepoint + +tracepoint(mode: HiTraceCommunicationMode, type: HiTraceTracePointType, id: HiTraceId, msg?: string): void + +信息埋点同步接口 + +- 参数： + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | mode | [HiTraceCommunicationMode](#hitracehitracecommunicationmode) | 是 | 信息埋点需要指定的跟踪通信模式。 | + | type | [HiTraceTracePointType](#hitracehitracetracepointtype)| 是 | 信息埋点需要指定的跟踪埋点类型。 | + | id | [HiTraceId](#hitracehitraceid) | 是 | 实施信息埋点操作的HiTraceId实例。 | + | msg | string | 否 | 信息埋点操作传入的trace说明信息。 | + +- 示例： + ``` + let asyncTraceId = hitrace.begin("business", hitrace.HiTraceFlag.INCLUDE_ASYNC | hitrace.HiTraceFlag.DONOT_CREATE_SPAN); + ... + hitrace.tracepoint(hitrace.HiTraceCommunicationMode.THREAD, hitrace.HiTraceTracePointType.SS, asyncTraceId, "Just a example"); + ``` + +## hitrace.isValid + +isValid(id: HiTraceId): boolean + +判断HiTraceId对象是否有效同步接口 + +- 参数： + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | id | [HiTraceId](#hitracehitraceid) | 是 | 需要判断是否有效的HiTraceId实例。 | +- 返回值： + | 类型 | 说明 | + | -------- | -------- | + | boolean | 判断HiTraceId是否有效的结果。 | + +- 示例： + ``` + let traceId = hitrace.begin("business"); + ... + let traceIdIsvalid = hitrace.isValid(traceId); + ``` + +## hitrace.isFlagEnabled + +isFlagEnabled(id: HiTraceId, flag: HiTraceFlag): boolean + +判断HiTraceId对象中指定的跟踪标志是否置位同步接口 + +- 参数： + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | id | [HiTraceId](#hitracehitraceid) | 是 | 需要判断指定跟踪标志是否置位的HiTraceId实例。 | + | flag | [HiTraceFlag](#hitracehitraceflag) | 是 | 指定的跟踪标志。 | + +- 示例： + ``` + let asyncTraceId = hitrace.begin("business", hitrace.HiTraceFlag.INCLUDE_ASYNC); + ... + // enabledDoNotCreateSpanFlag为true + let enabledDoNotCreateSpanFlag = hitrace.isFlagEnabled(asyncTraceId, hitrace.HiTraceFlag.INCLUDE_ASYNC); + ``` + +## hitrace.enableFlag + +enableFlag(id: HiTraceId, flag: HiTraceFlag): void + +置位HiTraceId对象中指定的跟踪标志同步接口 + +- 参数： + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | id | [HiTraceId](#hitracehitraceid) | 是 | 需要置位指定跟踪标志的HiTraceId实例。 | + | flag | [HiTraceFlag](#hitracehitraceflag) | 是 | 指定的跟踪标志。 | + +- 示例： + ``` + let asyncTraceId = hitrace.begin("business", hitrace.HiTraceFlag.INCLUDE_ASYNC); + hitrace.enable(asyncTraceId, hitrace.HiTraceFlag.DONOT_CREATE_SPAN); + // enabledDoNotCreateSpanFlag为true + let enabledDoNotCreateSpanFlag = hitrace.isFlagEnabled(asyncTraceId, hitrace.HiTraceFlag.DONOT_CREATE_SPAN); + ``` -- Gitee From ddbd3cebde04fb7df4d7330c54db8daf127673e2 Mon Sep 17 00:00:00 2001 From: xuyong Date: Wed, 9 Feb 2022 17:23:02 +0800 Subject: [PATCH 02/13] =?UTF-8?q?=E6=96=B0=E5=A2=9EHiTrace=20JS=20API?= =?UTF-8?q?=E6=96=87=E6=A1=A3?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: xuyong --- .../reference/apis/js-apis-hitrace.md | 36 +++++++++---------- 1 file changed, 18 insertions(+), 18 deletions(-) diff --git a/zh-cn/application-dev/reference/apis/js-apis-hitrace.md b/zh-cn/application-dev/reference/apis/js-apis-hitrace.md index 71cd8b1eb56..d750847b54b 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-hitrace.md +++ b/zh-cn/application-dev/reference/apis/js-apis-hitrace.md @@ -13,7 +13,7 @@ import hitrace from '@ohos.hitrace'; 无 -## hitrace.HiTraceFlag +## HiTraceFlag 跟踪标志组合类型枚举 @@ -28,7 +28,7 @@ import hitrace from '@ohos.hitrace'; | FAILURE_TRIGGER | 1 << 5 | 故障触发标志 | | D2D_TP_INFO | 1 << 6 | 设备间埋点标志 | -## hitrace.HiTraceTracePointType +## HiTraceTracePointType 跟踪埋点类型枚举 @@ -40,7 +40,7 @@ import hitrace from '@ohos.hitrace'; | SR | 3 | 服务端接收类型 | | GENERAL | 4 | 常规类型 | -## hitrace.HiTraceCommunicationMode +## HiTraceCommunicationMode 跟踪通信类型枚举 @@ -51,7 +51,7 @@ import hitrace from '@ohos.hitrace'; | PROCESS | 2 | 进程间通信类型 | | DEVICE | 3 | 设备间通信类型 | -## hitrace.HiTraceId +## HiTraceId 此接口为HiTraceId对象接口 @@ -72,11 +72,11 @@ begin(name: string, flags: number = HiTraceFlag.DEFAULT): HiTraceId | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | name | string | 是 | 跟踪业务名。 | - | flags | number | 是 | [跟踪标志组合](#hitracehitraceflag)。 | + | flags | number | 是 | [跟踪标志组合](#hitraceflag)。 | - 返回值： | 类型 | 说明 | | -------- | -------- | - | [HiTraceId](#hitracehitraceid) | HiTraceId实例。 | + | [HiTraceId](#hitraceid) | HiTraceId实例。 | - 示例： ``` @@ -92,7 +92,7 @@ end(id: HiTraceId): void - 参数： | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | - | id | [HiTraceId](#hitracehitraceid) | 是 | HiTraceId实例。 | + | id | [HiTraceId](#hitraceid) | 是 | HiTraceId实例。 | - 示例： ``` @@ -110,7 +110,7 @@ getId(): HiTraceId - 返回值： | 类型 | 说明 | | -------- | -------- | - | [HiTraceId](#hitracehitraceid) | HiTraceId实例。 | + | [HiTraceId](#hitraceid) | HiTraceId实例。 | - 示例： ``` @@ -129,7 +129,7 @@ setId(id: HiTraceId): void - 参数： | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | - | id | [HiTraceId](#hitracehitraceid) | 是 | HiTraceId实例。 | + | id | [HiTraceId](#hitraceid) | 是 | HiTraceId实例。 | - 示例： ``` @@ -162,7 +162,7 @@ createSpan(): HiTraceId - 返回值： | 类型 | 说明 | | -------- | -------- | - | [HiTraceId](#hitracehitraceid) | HiTraceId实例。 | + | [HiTraceId](#hitraceid) | HiTraceId实例。 | - 示例： ``` @@ -181,9 +181,9 @@ tracepoint(mode: HiTraceCommunicationMode, type: HiTraceTracePointType, id: HiTr - 参数： | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | - | mode | [HiTraceCommunicationMode](#hitracehitracecommunicationmode) | 是 | 信息埋点需要指定的跟踪通信模式。 | - | type | [HiTraceTracePointType](#hitracehitracetracepointtype)| 是 | 信息埋点需要指定的跟踪埋点类型。 | - | id | [HiTraceId](#hitracehitraceid) | 是 | 实施信息埋点操作的HiTraceId实例。 | + | mode | [HiTraceCommunicationMode](#hitracecommunicationmode) | 是 | 信息埋点需要指定的跟踪通信模式。 | + | type | [HiTraceTracePointType](#hitracetracepointtype)| 是 | 信息埋点需要指定的跟踪埋点类型。 | + | id | [HiTraceId](#hitraceid) | 是 | 实施信息埋点操作的HiTraceId实例。 | | msg | string | 否 | 信息埋点操作传入的trace说明信息。 | - 示例： @@ -202,7 +202,7 @@ isValid(id: HiTraceId): boolean - 参数： | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | - | id | [HiTraceId](#hitracehitraceid) | 是 | 需要判断是否有效的HiTraceId实例。 | + | id | [HiTraceId](#hitraceid) | 是 | 需要判断是否有效的HiTraceId实例。 | - 返回值： | 类型 | 说明 | | -------- | -------- | @@ -224,8 +224,8 @@ isFlagEnabled(id: HiTraceId, flag: HiTraceFlag): boolean - 参数： | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | - | id | [HiTraceId](#hitracehitraceid) | 是 | 需要判断指定跟踪标志是否置位的HiTraceId实例。 | - | flag | [HiTraceFlag](#hitracehitraceflag) | 是 | 指定的跟踪标志。 | + | id | [HiTraceId](#hitraceid) | 是 | 需要判断指定跟踪标志是否置位的HiTraceId实例。 | + | flag | [HiTraceFlag](#hitraceflag) | 是 | 指定的跟踪标志。 | - 示例： ``` @@ -244,8 +244,8 @@ enableFlag(id: HiTraceId, flag: HiTraceFlag): void - 参数： | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | - | id | [HiTraceId](#hitracehitraceid) | 是 | 需要置位指定跟踪标志的HiTraceId实例。 | - | flag | [HiTraceFlag](#hitracehitraceflag) | 是 | 指定的跟踪标志。 | + | id | [HiTraceId](#hitraceid) | 是 | 需要置位指定跟踪标志的HiTraceId实例。 | + | flag | [HiTraceFlag](#hitraceflag) | 是 | 指定的跟踪标志。 | - 示例： ``` -- Gitee From 8d31be52928713215afd75c55468d6500dae1bca Mon Sep 17 00:00:00 2001 From: xuyong Date: Wed, 9 Feb 2022 17:57:23 +0800 Subject: [PATCH 03/13] =?UTF-8?q?=E6=96=B0=E5=A2=9EHiTrace=20JS=20API?= =?UTF-8?q?=E6=96=87=E6=A1=A3?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: xuyong --- zh-cn/application-dev/reference/apis/js-apis-hitrace.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/zh-cn/application-dev/reference/apis/js-apis-hitrace.md b/zh-cn/application-dev/reference/apis/js-apis-hitrace.md index d750847b54b..7d96fef06ce 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-hitrace.md +++ b/zh-cn/application-dev/reference/apis/js-apis-hitrace.md @@ -9,9 +9,9 @@ import hitrace from '@ohos.hitrace'; ``` -## 权限 +## 系统能力 -无 +SystemCapability.HiviewDFX.HITrace ## HiTraceFlag -- Gitee From 5965c23e15c6d363a285b6deb17abc93cf5a3c29 Mon Sep 17 00:00:00 2001 From: xuyong Date: Wed, 9 Feb 2022 17:58:08 +0800 Subject: [PATCH 04/13] =?UTF-8?q?=E6=96=B0=E5=A2=9EHiTrace=20JS=20API?= =?UTF-8?q?=E6=96=87=E6=A1=A3?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: xuyong --- zh-cn/application-dev/reference/apis/js-apis-hitrace.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/zh-cn/application-dev/reference/apis/js-apis-hitrace.md b/zh-cn/application-dev/reference/apis/js-apis-hitrace.md index 7d96fef06ce..472c1d0b3fd 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-hitrace.md +++ b/zh-cn/application-dev/reference/apis/js-apis-hitrace.md @@ -11,7 +11,7 @@ import hitrace from '@ohos.hitrace'; ## 系统能力 -SystemCapability.HiviewDFX.HITrace +SystemCapability.HiviewDFX.HiTrace ## HiTraceFlag -- Gitee From c0cda04054799e159c0138f24f71e145386586ce Mon Sep 17 00:00:00 2001 From: xuyong Date: Wed, 9 Feb 2022 17:59:33 +0800 Subject: [PATCH 05/13] =?UTF-8?q?=E6=96=B0=E5=A2=9EHiTrace=20JS=20API?= =?UTF-8?q?=E6=96=87=E6=A1=A3?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: xuyong --- .../reference/apis/js-apis-hitrace.md | 28 +++++++++---------- 1 file changed, 14 insertions(+), 14 deletions(-) diff --git a/zh-cn/application-dev/reference/apis/js-apis-hitrace.md b/zh-cn/application-dev/reference/apis/js-apis-hitrace.md index 472c1d0b3fd..b25d23158df 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-hitrace.md +++ b/zh-cn/application-dev/reference/apis/js-apis-hitrace.md @@ -15,7 +15,7 @@ SystemCapability.HiviewDFX.HiTrace ## HiTraceFlag -跟踪标志组合类型枚举 +跟踪标志组合类型枚举。 | 名称 | 默认值 | 说明 | | -------- | -------- | -------- | @@ -30,7 +30,7 @@ SystemCapability.HiviewDFX.HiTrace ## HiTraceTracePointType -跟踪埋点类型枚举 +跟踪埋点类型枚举。 | 名称 | 默认值 | 说明 | | -------- | -------- | -------- | @@ -42,7 +42,7 @@ SystemCapability.HiviewDFX.HiTrace ## HiTraceCommunicationMode -跟踪通信类型枚举 +跟踪通信类型枚举。 | 名称 | 默认值 | 说明 | | -------- | -------- | -------- | @@ -53,7 +53,7 @@ SystemCapability.HiviewDFX.HiTrace ## HiTraceId -此接口为HiTraceId对象接口 +此接口为HiTraceId对象接口。 | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | @@ -66,7 +66,7 @@ SystemCapability.HiviewDFX.HiTrace begin(name: string, flags: number = HiTraceFlag.DEFAULT): HiTraceId -跟踪开始同步接口 +跟踪开始同步接口。 - 参数： | 参数名 | 类型 | 必填 | 说明 | @@ -87,7 +87,7 @@ begin(name: string, flags: number = HiTraceFlag.DEFAULT): HiTraceId end(id: HiTraceId): void -跟踪结束同步接口 +跟踪结束同步接口。 - 参数： | 参数名 | 类型 | 必填 | 说明 | @@ -105,7 +105,7 @@ end(id: HiTraceId): void getId(): HiTraceId -获取跟踪标识同步接口 +获取跟踪标识同步接口。 - 返回值： | 类型 | 说明 | @@ -124,7 +124,7 @@ getId(): HiTraceId setId(id: HiTraceId): void -设置跟踪标识同步接口 +设置跟踪标识同步接口。 - 参数： | 参数名 | 类型 | 必填 | 说明 | @@ -143,7 +143,7 @@ setId(id: HiTraceId): void clearId(): void -清除跟踪标识同步接口 +清除跟踪标识同步接口。 - 示例： ``` @@ -157,7 +157,7 @@ clearId(): void createSpan(): HiTraceId -创建跟踪分支同步接口 +创建跟踪分支同步接口。 - 返回值： | 类型 | 说明 | @@ -176,7 +176,7 @@ createSpan(): HiTraceId tracepoint(mode: HiTraceCommunicationMode, type: HiTraceTracePointType, id: HiTraceId, msg?: string): void -信息埋点同步接口 +信息埋点同步接口。 - 参数： | 参数名 | 类型 | 必填 | 说明 | @@ -197,7 +197,7 @@ tracepoint(mode: HiTraceCommunicationMode, type: HiTraceTracePointType, id: HiTr isValid(id: HiTraceId): boolean -判断HiTraceId对象是否有效同步接口 +判断HiTraceId对象是否有效同步接口。 - 参数： | 参数名 | 类型 | 必填 | 说明 | @@ -219,7 +219,7 @@ isValid(id: HiTraceId): boolean isFlagEnabled(id: HiTraceId, flag: HiTraceFlag): boolean -判断HiTraceId对象中指定的跟踪标志是否置位同步接口 +判断HiTraceId对象中指定的跟踪标志是否置位同步接口。 - 参数： | 参数名 | 类型 | 必填 | 说明 | @@ -239,7 +239,7 @@ isFlagEnabled(id: HiTraceId, flag: HiTraceFlag): boolean enableFlag(id: HiTraceId, flag: HiTraceFlag): void -置位HiTraceId对象中指定的跟踪标志同步接口 +置位HiTraceId对象中指定的跟踪标志同步接口。 - 参数： | 参数名 | 类型 | 必填 | 说明 | -- Gitee From bf5b91bd38c5b2e12048f7e1cb5e7e178ccfc808 Mon Sep 17 00:00:00 2001 From: xuyong Date: Wed, 9 Feb 2022 18:50:10 +0800 Subject: [PATCH 06/13] =?UTF-8?q?=E6=96=B0=E5=A2=9EHiTrace=20JS=20API?= =?UTF-8?q?=E6=96=87=E6=A1=A3?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: xuyong --- .../reference/apis/js-apis-hitrace.md | 45 +++++++++---------- 1 file changed, 21 insertions(+), 24 deletions(-) diff --git a/zh-cn/application-dev/reference/apis/js-apis-hitrace.md b/zh-cn/application-dev/reference/apis/js-apis-hitrace.md index b25d23158df..4cd46ac166c 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-hitrace.md +++ b/zh-cn/application-dev/reference/apis/js-apis-hitrace.md @@ -66,7 +66,7 @@ SystemCapability.HiviewDFX.HiTrace begin(name: string, flags: number = HiTraceFlag.DEFAULT): HiTraceId -跟踪开始同步接口。 +开始跟踪，同步接口。 - 参数： | 参数名 | 类型 | 必填 | 说明 | @@ -87,7 +87,7 @@ begin(name: string, flags: number = HiTraceFlag.DEFAULT): HiTraceId end(id: HiTraceId): void -跟踪结束同步接口。 +结束跟踪，同步接口。 - 参数： | 参数名 | 类型 | 必填 | 说明 | @@ -97,7 +97,7 @@ end(id: HiTraceId): void - 示例： ``` let asyncTraceId = hitrace.begin("business"); - ... + // 若干业务逻辑完成后，结束跟踪。 hitrace.end(asyncTraceId); ``` @@ -105,7 +105,7 @@ end(id: HiTraceId): void getId(): HiTraceId -获取跟踪标识同步接口。 +获取跟踪标识，同步接口。 - 返回值： | 类型 | 说明 | @@ -115,16 +115,15 @@ getId(): HiTraceId - 示例： ``` let traceId = hitrace.begin("business"); - ... + // 若干业务逻辑完成后，获取当前HiTraceId。 let curTraceId = hitrace.getId(); - ... ``` ## hitrace.setId setId(id: HiTraceId): void -设置跟踪标识同步接口。 +设置跟踪标识，同步接口。 - 参数： | 参数名 | 类型 | 必填 | 说明 | @@ -134,30 +133,28 @@ setId(id: HiTraceId): void - 示例： ``` let traceId = hitrace.begin("business"); - ... + // 若干业务逻辑完成后，设置当前HiTraceId。 hitrace.setId(asyncTraceId); - ... ``` ## hitrace.clearId clearId(): void -清除跟踪标识同步接口。 +清除跟踪标识，同步接口。 - 示例： ``` let traceId = hitrace.begin("business"); - ... + // 若干业务逻辑完成后，清除当前HiTraceId。 hitrace.clearId(); - ... ``` ## hitrace.createSpan createSpan(): HiTraceId -创建跟踪分支同步接口。 +创建跟踪分支，同步接口。 - 返回值： | 类型 | 说明 | @@ -167,16 +164,15 @@ createSpan(): HiTraceId - 示例： ``` let traceId = hitrace.begin("business"); - ... + // 若干业务逻辑完成后，创建跟踪分支。 let spanTraceId = hitrace.createSpan(); - ... ``` ## hitrace.tracepoint tracepoint(mode: HiTraceCommunicationMode, type: HiTraceTracePointType, id: HiTraceId, msg?: string): void -信息埋点同步接口。 +信息埋点，同步接口。 - 参数： | 参数名 | 类型 | 必填 | 说明 | @@ -189,7 +185,7 @@ tracepoint(mode: HiTraceCommunicationMode, type: HiTraceTracePointType, id: HiTr - 示例： ``` let asyncTraceId = hitrace.begin("business", hitrace.HiTraceFlag.INCLUDE_ASYNC | hitrace.HiTraceFlag.DONOT_CREATE_SPAN); - ... + // 若干业务逻辑完成后，触发信息埋点操作。 hitrace.tracepoint(hitrace.HiTraceCommunicationMode.THREAD, hitrace.HiTraceTracePointType.SS, asyncTraceId, "Just a example"); ``` @@ -197,7 +193,7 @@ tracepoint(mode: HiTraceCommunicationMode, type: HiTraceTracePointType, id: HiTr isValid(id: HiTraceId): boolean -判断HiTraceId对象是否有效同步接口。 +判断HiTraceId对象是否有效，同步接口。 - 参数： | 参数名 | 类型 | 必填 | 说明 | @@ -206,12 +202,11 @@ isValid(id: HiTraceId): boolean - 返回值： | 类型 | 说明 | | -------- | -------- | - | boolean | 判断HiTraceId是否有效的结果。 | + | boolean | 返回true表示HiTraceId有效，否则无效。 | - 示例： ``` let traceId = hitrace.begin("business"); - ... let traceIdIsvalid = hitrace.isValid(traceId); ``` @@ -219,18 +214,20 @@ isValid(id: HiTraceId): boolean isFlagEnabled(id: HiTraceId, flag: HiTraceFlag): boolean -判断HiTraceId对象中指定的跟踪标志是否置位同步接口。 +判断HiTraceId对象中指定的跟踪标志是否已置位，同步接口。 - 参数： | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | id | [HiTraceId](#hitraceid) | 是 | 需要判断指定跟踪标志是否置位的HiTraceId实例。 | | flag | [HiTraceFlag](#hitraceflag) | 是 | 指定的跟踪标志。 | - +- 返回值： + | 类型 | 说明 | + | -------- | -------- | + | boolean | 返回true标识HiTraceId已置位指定的flag，否则没有置位。 | - 示例： ``` let asyncTraceId = hitrace.begin("business", hitrace.HiTraceFlag.INCLUDE_ASYNC); - ... // enabledDoNotCreateSpanFlag为true let enabledDoNotCreateSpanFlag = hitrace.isFlagEnabled(asyncTraceId, hitrace.HiTraceFlag.INCLUDE_ASYNC); ``` @@ -239,7 +236,7 @@ isFlagEnabled(id: HiTraceId, flag: HiTraceFlag): boolean enableFlag(id: HiTraceId, flag: HiTraceFlag): void -置位HiTraceId对象中指定的跟踪标志同步接口。 +置位HiTraceId对象中指定的跟踪标志，同步接口。 - 参数： | 参数名 | 类型 | 必填 | 说明 | -- Gitee From b4d4153baf2235e33edf5decdff37e61bc29d163 Mon Sep 17 00:00:00 2001 From: xuyong Date: Thu, 10 Feb 2022 19:16:40 +0800 Subject: [PATCH 07/13] =?UTF-8?q?HiTrace=20JS=20api=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 --- .../reference/apis/Readme-CN.md | 4 +- ...pis-hitrace.md => js-apis-hitracechain.md} | 62 +++++----- .../reference/apis/js-apis-hitracemeter.md | 107 ++++++++++++++++++ 3 files changed, 140 insertions(+), 33 deletions(-) rename zh-cn/application-dev/reference/apis/{js-apis-hitrace.md => js-apis-hitracechain.md} (74%) create mode 100644 zh-cn/application-dev/reference/apis/js-apis-hitracemeter.md diff --git a/zh-cn/application-dev/reference/apis/Readme-CN.md b/zh-cn/application-dev/reference/apis/Readme-CN.md index 647304ff3ba..5557c9c32d4 100644 --- a/zh-cn/application-dev/reference/apis/Readme-CN.md +++ b/zh-cn/application-dev/reference/apis/Readme-CN.md @@ -66,9 +66,9 @@ - [设置系统时间](js-apis-system-time.md) - [动画](js-apis-basic-features-animator.md) - [应用打点](js-apis-hiappevent.md) - - [性能打点](js-apis-bytrace.md) + - [性能打点](js-apis-hitracemeter.md) - [故障日志获取](js-apis-faultLogger.md) - - [分布式跟踪](js-apis-hitrace.md) + - [分布式跟踪](js-apis-hitracechain.md) - 语言基础类库 - [获取进程相关的信息](js-apis-process.md) - [URL字符串解析](js-apis-url.md) diff --git a/zh-cn/application-dev/reference/apis/js-apis-hitrace.md b/zh-cn/application-dev/reference/apis/js-apis-hitracechain.md similarity index 74% rename from zh-cn/application-dev/reference/apis/js-apis-hitrace.md rename to zh-cn/application-dev/reference/apis/js-apis-hitracechain.md index 4cd46ac166c..ca0fcee2585 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-hitrace.md +++ b/zh-cn/application-dev/reference/apis/js-apis-hitracechain.md @@ -6,7 +6,7 @@ ## 导入模块 ``` -import hitrace from '@ohos.hitrace'; +import hiTraceChain from '@ohos.hiTraceChain'; ``` ## 系统能力 @@ -62,7 +62,7 @@ SystemCapability.HiviewDFX.HiTrace | parentSpanId | number | 否 | 父分支标识。 | | flags | number | 否 | 跟踪标志组合。 | -## hitrace.begin +## hiTraceChain.begin begin(name: string, flags: number = HiTraceFlag.DEFAULT): HiTraceId @@ -80,10 +80,10 @@ begin(name: string, flags: number = HiTraceFlag.DEFAULT): HiTraceId - 示例： ``` - let asyncTraceId = hitrace.begin("business", hitrace.HiTraceFlag.INCLUDE_ASYNC | hitrace.HiTraceFlag.DONOT_CREATE_SPAN); + let asyncTraceId = hiTraceChain.begin("business", hiTraceChain.HiTraceFlag.INCLUDE_ASYNC | hiTraceChain.HiTraceFlag.DONOT_CREATE_SPAN); ``` -## hitrace.end +## hiTraceChain.end end(id: HiTraceId): void @@ -96,12 +96,12 @@ end(id: HiTraceId): void - 示例： ``` - let asyncTraceId = hitrace.begin("business"); + let asyncTraceId = hiTraceChain.begin("business"); // 若干业务逻辑完成后，结束跟踪。 - hitrace.end(asyncTraceId); + hiTraceChain.end(asyncTraceId); ``` -## hitrace.getId +## hiTraceChain.getId getId(): HiTraceId @@ -114,12 +114,12 @@ getId(): HiTraceId - 示例： ``` - let traceId = hitrace.begin("business"); + let traceId = hiTraceChain.begin("business"); // 若干业务逻辑完成后，获取当前HiTraceId。 - let curTraceId = hitrace.getId(); + let curTraceId = hiTraceChain.getId(); ``` -## hitrace.setId +## hiTraceChain.setId setId(id: HiTraceId): void @@ -132,12 +132,12 @@ setId(id: HiTraceId): void - 示例： ``` - let traceId = hitrace.begin("business"); + let traceId = hiTraceChain.begin("business"); // 若干业务逻辑完成后，设置当前HiTraceId。 - hitrace.setId(asyncTraceId); + hiTraceChain.setId(asyncTraceId); ``` -## hitrace.clearId +## hiTraceChain.clearId clearId(): void @@ -145,12 +145,12 @@ clearId(): void - 示例： ``` - let traceId = hitrace.begin("business"); + let traceId = hiTraceChain.begin("business"); // 若干业务逻辑完成后，清除当前HiTraceId。 - hitrace.clearId(); + hiTraceChain.clearId(); ``` -## hitrace.createSpan +## hiTraceChain.createSpan createSpan(): HiTraceId @@ -163,12 +163,12 @@ createSpan(): HiTraceId - 示例： ``` - let traceId = hitrace.begin("business"); + let traceId = hiTraceChain.begin("business"); // 若干业务逻辑完成后，创建跟踪分支。 - let spanTraceId = hitrace.createSpan(); + let spanTraceId = hiTraceChain.createSpan(); ``` -## hitrace.tracepoint +## hiTraceChain.tracepoint tracepoint(mode: HiTraceCommunicationMode, type: HiTraceTracePointType, id: HiTraceId, msg?: string): void @@ -184,12 +184,12 @@ tracepoint(mode: HiTraceCommunicationMode, type: HiTraceTracePointType, id: HiTr - 示例： ``` - let asyncTraceId = hitrace.begin("business", hitrace.HiTraceFlag.INCLUDE_ASYNC | hitrace.HiTraceFlag.DONOT_CREATE_SPAN); + let asyncTraceId = hiTraceChain.begin("business", hiTraceChain.HiTraceFlag.INCLUDE_ASYNC | hiTraceChain.HiTraceFlag.DONOT_CREATE_SPAN); // 若干业务逻辑完成后，触发信息埋点操作。 - hitrace.tracepoint(hitrace.HiTraceCommunicationMode.THREAD, hitrace.HiTraceTracePointType.SS, asyncTraceId, "Just a example"); + hiTraceChain.tracepoint(hiTraceChain.HiTraceCommunicationMode.THREAD, hiTraceChain.HiTraceTracePointType.SS, asyncTraceId, "Just a example"); ``` -## hitrace.isValid +## hiTraceChain.isValid isValid(id: HiTraceId): boolean @@ -206,11 +206,11 @@ isValid(id: HiTraceId): boolean - 示例： ``` - let traceId = hitrace.begin("business"); - let traceIdIsvalid = hitrace.isValid(traceId); + let traceId = hiTraceChain.begin("business"); + let traceIdIsvalid = hiTraceChain.isValid(traceId); ``` -## hitrace.isFlagEnabled +## hiTraceChain.isFlagEnabled isFlagEnabled(id: HiTraceId, flag: HiTraceFlag): boolean @@ -227,12 +227,12 @@ isFlagEnabled(id: HiTraceId, flag: HiTraceFlag): boolean | boolean | 返回true标识HiTraceId已置位指定的flag，否则没有置位。 | - 示例： ``` - let asyncTraceId = hitrace.begin("business", hitrace.HiTraceFlag.INCLUDE_ASYNC); + let asyncTraceId = hiTraceChain.begin("business", hiTraceChain.HiTraceFlag.INCLUDE_ASYNC); // enabledDoNotCreateSpanFlag为true - let enabledDoNotCreateSpanFlag = hitrace.isFlagEnabled(asyncTraceId, hitrace.HiTraceFlag.INCLUDE_ASYNC); + let enabledDoNotCreateSpanFlag = hiTraceChain.isFlagEnabled(asyncTraceId, hiTraceChain.HiTraceFlag.INCLUDE_ASYNC); ``` -## hitrace.enableFlag +## hiTraceChain.enableFlag enableFlag(id: HiTraceId, flag: HiTraceFlag): void @@ -246,8 +246,8 @@ enableFlag(id: HiTraceId, flag: HiTraceFlag): void - 示例： ``` - let asyncTraceId = hitrace.begin("business", hitrace.HiTraceFlag.INCLUDE_ASYNC); - hitrace.enable(asyncTraceId, hitrace.HiTraceFlag.DONOT_CREATE_SPAN); + let asyncTraceId = hiTraceChain.begin("business", hiTraceChain.HiTraceFlag.INCLUDE_ASYNC); + hiTraceChain.enable(asyncTraceId, hiTraceChain.HiTraceFlag.DONOT_CREATE_SPAN); // enabledDoNotCreateSpanFlag为true - let enabledDoNotCreateSpanFlag = hitrace.isFlagEnabled(asyncTraceId, hitrace.HiTraceFlag.DONOT_CREATE_SPAN); + let enabledDoNotCreateSpanFlag = hiTraceChain.isFlagEnabled(asyncTraceId, hiTraceChain.HiTraceFlag.DONOT_CREATE_SPAN); ``` diff --git a/zh-cn/application-dev/reference/apis/js-apis-hitracemeter.md b/zh-cn/application-dev/reference/apis/js-apis-hitracemeter.md new file mode 100644 index 00000000000..712409d46d3 --- /dev/null +++ b/zh-cn/application-dev/reference/apis/js-apis-hitracemeter.md @@ -0,0 +1,107 @@ +# 性能打点 + +> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：** +> 本模块首批接口从API version 8开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 + + +## 导入模块 + +``` +import hiTraceMeter from '@ohos.hiTraceMeter'; +``` + + +## 系统能力 + +SystemCapability.HiviewDFX.HiTrace + + +## hiTraceMeter.startTrace + +startTrace(name: string, taskId: number, expectedTime?: number): void + +标记一个预追踪耗时任务的开始，expectedTime是可选参数，标识该任务的期望耗时。 + + +- 参数： + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | name | string | 是 | 要追踪的任务名称 | + | taskId | number | 是 | 任务id | + | expectedTime | number | 否 | 期望的耗时时间，单位：ms | + + > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：** + > 如果有多个相同name的任务需要追踪或者对同一个任务要追踪多次，并且这些会同时被执行，则每次调用startTrace的taskId必须不一致。如果具有相同name的任务是串行执行的，则taskId可以相同。在下面hiTraceMeter.finishTrace的示例中会举例说明。 + +- 示例： + ``` + hiTraceMeter.startTrace("myTestFunc", 1); + hiTraceMeter.startTrace("myTestFunc", 1, 5); //从startTrace到finishTrace流程的耗时期望为5ms + ``` + + +## hiTraceMeter.finishTrace + +finishTrace(name: string, taskId: number): void + +标记一个预追踪耗时任务的结束。 + + +- 参数： + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | name | string | 是 | 要追踪的任务名称 | + | taskId | number | 是 | 任务id | + + > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：** + > finishTrace的name和taskId必须与流程开始的startTrace对应参数值一致。 + +- 示例： + ``` + hiTraceMeter.finishTrace("myTestFunc", 1); + ``` + + ``` + //追踪并行执行的同名任务 + hiTraceMeter.startTrace("myTestFunc", 1); + //业务流程...... + hiTraceMeter.startTrace("myTestFunc", 2); //第二个追踪的任务开始，同时第一个追踪的同名任务还没结束，出现了并行执行，对应接口的taskId需要不同。 + //业务流程...... + hiTraceMeter.finishTrace("myTestFunc", 1); + //业务流程...... + hiTraceMeter.finishTrace("myTestFunc", 2); + ``` + + ``` + //追踪串行执行的同名任务 + hiTraceMeter.startTrace("myTestFunc", 1); + //业务流程...... + hiTraceMeter.finishTrace("myTestFunc", 1); //第一个追踪的任务结束 + //业务流程...... + hiTraceMeter.startTrace("myTestFunc", 1); //第二个追踪的同名任务开始，同名的待追踪任务串行执行。 + //业务流程...... + hiTraceMeter.finishTrace("myTestFunc", 1); + ``` + + +## hiTraceMeter.traceByValue + +traceByValue(name: string, value: number): void + +用来标记一个预追踪的数值变量，该变量的数值会不断变化。 + + +- 参数： + | 参数名 | 类型 | 必填 | 说明 | + | -------- | -------- | -------- | -------- | + | name | string | 是 | 要追踪的数值变量名称 | + | value | number | 是 | 变量的值 | + +- 示例： + ``` + let traceCount = 3; + hiTraceMeter.traceByValue("myTestCount", traceCount); + traceCount = 4; + hiTraceMeter.traceByValue("myTestCount", traceCount); + //业务流程...... + ``` -- Gitee From ecd3142ac5825349dfff19ff1e5330ace42da4b0 Mon Sep 17 00:00:00 2001 From: xuyong Date: Tue, 15 Feb 2022 14:21:03 +0800 Subject: [PATCH 08/13] HiTrace Js API Signed-off-by: xuyong --- zh-cn/application-dev/reference/apis/js-apis-bytrace.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/zh-cn/application-dev/reference/apis/js-apis-bytrace.md b/zh-cn/application-dev/reference/apis/js-apis-bytrace.md index 0e8a5058d66..5de9d9c82c2 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-bytrace.md +++ b/zh-cn/application-dev/reference/apis/js-apis-bytrace.md @@ -1,3 +1,5 @@ +- 从API Version 8开始，该接口不再维护，推荐使用新接口[hiTraceMeter](js-apis-hitracemeter.md)。具体新接口在接口描述中说明。 + # 性能打点 > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：** -- Gitee From 30701bf02a3b8888af42bd6c9a0c361b04ce724c Mon Sep 17 00:00:00 2001 From: xuyong Date: Tue, 15 Feb 2022 14:22:37 +0800 Subject: [PATCH 09/13] HiTrace Js API Signed-off-by: xuyong --- zh-cn/application-dev/reference/apis/js-apis-bytrace.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/zh-cn/application-dev/reference/apis/js-apis-bytrace.md b/zh-cn/application-dev/reference/apis/js-apis-bytrace.md index 5de9d9c82c2..5b6cdf277f7 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-bytrace.md +++ b/zh-cn/application-dev/reference/apis/js-apis-bytrace.md @@ -1,8 +1,7 @@ -- 从API Version 8开始，该接口不再维护，推荐使用新接口[hiTraceMeter](js-apis-hitracemeter.md)。具体新接口在接口描述中说明。 - # 性能打点 > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：** +> 从API Version 8开始，该接口不再维护，推荐使用新接口[hiTraceMeter](js-apis-hitracemeter.md)。具体新接口在接口描述中说明。 > 本模块首批接口从API version 7开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 -- Gitee From 52bfe68058721fa65d518286a892fc8316256f14 Mon Sep 17 00:00:00 2001 From: xuyong Date: Tue, 15 Feb 2022 16:16:53 +0800 Subject: [PATCH 10/13] =?UTF-8?q?HiTrace=20JS=20=E6=96=87=E6=A1=A3?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: xuyong --- zh-cn/application-dev/reference/apis/js-apis-bytrace.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/zh-cn/application-dev/reference/apis/js-apis-bytrace.md b/zh-cn/application-dev/reference/apis/js-apis-bytrace.md index 5b6cdf277f7..029e6952cb1 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-bytrace.md +++ b/zh-cn/application-dev/reference/apis/js-apis-bytrace.md @@ -1,8 +1,8 @@ # 性能打点 > ![icon-note.gif](public_sys-resources/icon-note.gif) **说明：** -> 从API Version 8开始，该接口不再维护，推荐使用新接口[hiTraceMeter](js-apis-hitracemeter.md)。具体新接口在接口描述中说明。 -> 本模块首批接口从API version 7开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 +> - 从API Version 8开始，该接口不再维护，推荐使用新接口[hiTraceMeter](js-apis-hitracemeter.md)。具体新接口在接口描述中说明。 +> - 本模块首批接口从API version 7开始支持。后续版本的新增接口，采用上角标单独标记接口的起始版本。 ## 导入模块 -- Gitee From 0bc2592e6413d7e9bb8af1db7862f39d65815924 Mon Sep 17 00:00:00 2001 From: xuyong Date: Tue, 15 Feb 2022 16:24:42 +0800 Subject: [PATCH 11/13] =?UTF-8?q?HiTrace=20JS=20=E6=8E=A5=E5=8F=A3?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: xuyong --- zh-cn/application-dev/reference/apis/js-apis-hitracechain.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/zh-cn/application-dev/reference/apis/js-apis-hitracechain.md b/zh-cn/application-dev/reference/apis/js-apis-hitracechain.md index ca0fcee2585..57f77ebed77 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-hitracechain.md +++ b/zh-cn/application-dev/reference/apis/js-apis-hitracechain.md @@ -24,7 +24,7 @@ SystemCapability.HiviewDFX.HiTrace | DONOT_CREATE_SPAN | 1 << 1 | 无分支标志 | | TP_INFO | 1 << 2 | 埋点标志 | | NO_BE_INFO | 1 << 3 | 无起始结束标志 | -| DONOT_ENABLE_LOG | 1 << 4 | 日志关联标志 | +| DISABLE_LOG | 1 << 4 | 日志关联标志 | | FAILURE_TRIGGER | 1 << 5 | 故障触发标志 | | D2D_TP_INFO | 1 << 6 | 设备间埋点标志 | -- Gitee From 02eb67203b060ef3e1f29779d4fe2fe94c3e02f7 Mon Sep 17 00:00:00 2001 From: xuyong Date: Tue, 15 Feb 2022 16:36:13 +0800 Subject: [PATCH 12/13] =?UTF-8?q?HiTrace=20JS=20API=E6=96=87=E6=A1=A3?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: xuyong --- zh-cn/application-dev/reference/apis/js-apis-hitracechain.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/zh-cn/application-dev/reference/apis/js-apis-hitracechain.md b/zh-cn/application-dev/reference/apis/js-apis-hitracechain.md index 57f77ebed77..5e90cde18cd 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-hitracechain.md +++ b/zh-cn/application-dev/reference/apis/js-apis-hitracechain.md @@ -28,7 +28,7 @@ SystemCapability.HiviewDFX.HiTrace | FAILURE_TRIGGER | 1 << 5 | 故障触发标志 | | D2D_TP_INFO | 1 << 6 | 设备间埋点标志 | -## HiTraceTracePointType +## HiTraceTracepointType 跟踪埋点类型枚举。 -- Gitee From ead81bc3914db991ab247f912f326a9463ed23f9 Mon Sep 17 00:00:00 2001 From: xuyong Date: Tue, 15 Feb 2022 16:43:17 +0800 Subject: [PATCH 13/13] =?UTF-8?q?HiTrace=20Js=20=E6=96=87=E6=A1=A3?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: xuyong --- .../application-dev/reference/apis/js-apis-hitracechain.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/zh-cn/application-dev/reference/apis/js-apis-hitracechain.md b/zh-cn/application-dev/reference/apis/js-apis-hitracechain.md index 5e90cde18cd..a499e0b10a2 100644 --- a/zh-cn/application-dev/reference/apis/js-apis-hitracechain.md +++ b/zh-cn/application-dev/reference/apis/js-apis-hitracechain.md @@ -170,7 +170,7 @@ createSpan(): HiTraceId ## hiTraceChain.tracepoint -tracepoint(mode: HiTraceCommunicationMode, type: HiTraceTracePointType, id: HiTraceId, msg?: string): void +tracepoint(mode: HiTraceCommunicationMode, type: HiTraceTracepointType, id: HiTraceId, msg?: string): void 信息埋点，同步接口。 @@ -178,7 +178,7 @@ tracepoint(mode: HiTraceCommunicationMode, type: HiTraceTracePointType, id: HiTr | 参数名 | 类型 | 必填 | 说明 | | -------- | -------- | -------- | -------- | | mode | [HiTraceCommunicationMode](#hitracecommunicationmode) | 是 | 信息埋点需要指定的跟踪通信模式。 | - | type | [HiTraceTracePointType](#hitracetracepointtype)| 是 | 信息埋点需要指定的跟踪埋点类型。 | + | type | [HiTraceTracepointType](#hitracetracepointtype)| 是 | 信息埋点需要指定的跟踪埋点类型。 | | id | [HiTraceId](#hitraceid) | 是 | 实施信息埋点操作的HiTraceId实例。 | | msg | string | 否 | 信息埋点操作传入的trace说明信息。 | @@ -186,7 +186,7 @@ tracepoint(mode: HiTraceCommunicationMode, type: HiTraceTracePointType, id: HiTr ``` let asyncTraceId = hiTraceChain.begin("business", hiTraceChain.HiTraceFlag.INCLUDE_ASYNC | hiTraceChain.HiTraceFlag.DONOT_CREATE_SPAN); // 若干业务逻辑完成后，触发信息埋点操作。 - hiTraceChain.tracepoint(hiTraceChain.HiTraceCommunicationMode.THREAD, hiTraceChain.HiTraceTracePointType.SS, asyncTraceId, "Just a example"); + hiTraceChain.tracepoint(hiTraceChain.HiTraceCommunicationMode.THREAD, hiTraceChain.HiTraceTracepointType.SS, asyncTraceId, "Just a example"); ``` ## hiTraceChain.isValid -- Gitee