分布式跟踪


分布式跟踪

icon-note.gif 说明: 本模块首批接口从API version 8开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。

导入模块

import hiTraceChain from '@ohos.hiTraceChain';
1

HiTraceFlag

跟踪标志组合类型枚举。

系统能力: 以下各项对应的系统能力均为SystemCapability.HiviewDFX.HiTrace。

名称 默认值 说明
DEFAULT 0 缺省标志。
INCLUDE_ASYNC 1 异步调用标志。启动跟踪时,缺省只跟踪同步调用。设置该标志,同时跟踪同步、异步调用。
DONOT_CREATE_SPAN 1 << 1 无分支标志。启动跟踪时,在同步、异步调用时缺省自动创建分支信息。设置该标志,指示不创建分支。
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三个埋点信息。
NO_BE_INFO 1 << 3 无起始结束标志。启动跟踪时,缺省打印启动及结束跟踪信息。设置该标志,指示不打印启动及结束跟踪信息。
DISABLE_LOG 1 << 4 日志关联标志。设置该标志,指示隐藏日志中的跟踪信息。
FAILURE_TRIGGER 1 << 5 故障触发标志。预置标志,暂时没有作用。
D2D_TP_INFO 1 << 6 设备间埋点标志。TP_INFO的一个子集,设置该标志,只进行设备间的调用埋点。

HiTraceTracepointType

跟踪埋点类型枚举。

系统能力: 以下各项对应的系统能力均为SystemCapability.HiviewDFX.HiTrace。

名称 默认值 说明
CS 0 客户端发送类型,标识client侧的发送埋点。
CR 1 客户端接收类型,标识client侧的接收埋点。
SS 2 服务端发送类型,标识server侧的发送埋点。
SR 3 服务端接收类型,标识server侧的接收埋点。
GENERAL 4 一般类型,标识CS、CR、SS、SR四种场景之外的埋点。

HiTraceCommunicationMode

跟踪通信类型枚举。

系统能力: 以下各项对应的系统能力均为SystemCapability.HiviewDFX.HiTrace。

名称 默认值 说明
DEFAULT 0 缺省通信类型
THREAD 1 线程间通信类型
PROCESS 2 进程间通信类型
DEVICE 3 设备间通信类型

HiTraceId

此接口为HiTraceId对象接口。

系统能力: 以下各项对应的系统能力均为SystemCapability.HiviewDFX.HiTrace。

参数名 类型 必填 说明
chainId bigint 跟踪链标识。
spanId number 分支标识。
parentSpanId number 父分支标识。
flags number 跟踪标志组合。

hiTraceChain.begin

begin(name: string, flags: number = HiTraceFlag.DEFAULT): HiTraceId

开始跟踪,同步接口。

系统能力: SystemCapability.HiviewDFX.HiTrace

参数:

参数名 类型 必填 说明
name string 跟踪业务名。
flags number 跟踪标志组合,具体可参考HiTraceFlag

返回值:

类型 说明
HiTraceId HiTraceId实例。

示例:

let asyncTraceId = hiTraceChain.begin("business", hiTraceChain.HiTraceFlag.INCLUDE_ASYNC | hiTraceChain.HiTraceFlag.DONOT_CREATE_SPAN);
1

hiTraceChain.end

end(id: HiTraceId): void

结束跟踪,同步接口。

系统能力: SystemCapability.HiviewDFX.HiTrace

参数:

参数名 类型 必填 说明
id HiTraceId HiTraceId实例。

示例:

let asyncTraceId = hiTraceChain.begin("business");
// 若干业务逻辑完成后,结束跟踪。
hiTraceChain.end(asyncTraceId);
1
2
3

hiTraceChain.getId

getId(): HiTraceId

获取跟踪标识,同步接口。

系统能力: SystemCapability.HiviewDFX.HiTrace

返回值:

类型 说明
HiTraceId HiTraceId实例。

示例:

let traceId = hiTraceChain.begin("business");
// 若干业务逻辑完成后,获取当前HiTraceId。
let curTraceId = hiTraceChain.getId();
1
2
3

hiTraceChain.setId

setId(id: HiTraceId): void

设置跟踪标识,同步接口。

系统能力: SystemCapability.HiviewDFX.HiTrace

参数:

参数名 类型 必填 说明
id HiTraceId HiTraceId实例。

示例:

let traceId = hiTraceChain.begin("business");
// 若干业务逻辑完成后,设置当前HiTraceId。
hiTraceChain.setId(asyncTraceId);
1
2
3

hiTraceChain.clearId

clearId(): void

清除跟踪标识,同步接口。

系统能力: SystemCapability.HiviewDFX.HiTrace

示例:

let traceId = hiTraceChain.begin("business");
// 若干业务逻辑完成后,清除当前HiTraceId。
hiTraceChain.clearId();
1
2
3

hiTraceChain.createSpan

createSpan(): HiTraceId

创建跟踪分支,同步接口。

系统能力: SystemCapability.HiviewDFX.HiTrace

返回值:

类型 说明
HiTraceId HiTraceId实例。

示例:

let traceId = hiTraceChain.begin("business");
// 若干业务逻辑完成后,创建跟踪分支。
let spanTraceId = hiTraceChain.createSpan();
1
2
3

hiTraceChain.tracepoint

tracepoint(mode: HiTraceCommunicationMode, type: HiTraceTracepointType, id: HiTraceId, msg?: string): void

信息埋点,同步接口。

系统能力: SystemCapability.HiviewDFX.HiTrace

参数:

参数名 类型 必填 说明
mode HiTraceCommunicationMode 信息埋点需要指定的跟踪通信模式。
type HiTraceTracepointType 信息埋点需要指定的跟踪埋点类型。
id HiTraceId 实施信息埋点操作的HiTraceId实例。
msg string 信息埋点操作传入的trace说明信息。

示例:

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");
1
2
3

hiTraceChain.isValid

isValid(id: HiTraceId): boolean

判断HiTraceId对象是否有效,同步接口。

系统能力: SystemCapability.HiviewDFX.HiTrace

参数:

参数名 类型 必填 说明
id HiTraceId 需要判断是否有效的HiTraceId实例。

返回值:

类型 说明
boolean 返回true表示HiTraceId有效,否则无效。

示例:

let traceId = hiTraceChain.begin("business");
let traceIdIsvalid = hiTraceChain.isValid(traceId);
1
2

hiTraceChain.isFlagEnabled

isFlagEnabled(id: HiTraceId, flag: HiTraceFlag): boolean

判断HiTraceId对象中指定的跟踪标志是否已置位,同步接口。

系统能力: SystemCapability.HiviewDFX.HiTrace

参数:

参数名 类型 必填 说明
id HiTraceId 需要判断指定跟踪标志是否置位的HiTraceId实例。
flag HiTraceFlag 指定的跟踪标志。

返回值:

类型 说明
boolean 返回true标识HiTraceId已置位指定的flag,否则没有置位。

示例:

let asyncTraceId = hiTraceChain.begin("business", hiTraceChain.HiTraceFlag.INCLUDE_ASYNC);
// enabledDoNotCreateSpanFlag为true
let enabledDoNotCreateSpanFlag = hiTraceChain.isFlagEnabled(asyncTraceId, hiTraceChain.HiTraceFlag.INCLUDE_ASYNC);
1
2
3

hiTraceChain.enableFlag

enableFlag(id: HiTraceId, flag: HiTraceFlag): void

置位HiTraceId对象中指定的跟踪标志,同步接口。

系统能力: SystemCapability.HiviewDFX.HiTrace

参数:

参数名 类型 必填 说明
id HiTraceId 需要置位指定跟踪标志的HiTraceId实例。
flag HiTraceFlag 指定的跟踪标志。

示例:

let asyncTraceId = hiTraceChain.begin("business", hiTraceChain.HiTraceFlag.INCLUDE_ASYNC);
hiTraceChain.enable(asyncTraceId, hiTraceChain.HiTraceFlag.DONOT_CREATE_SPAN);
// enabledDoNotCreateSpanFlag为true
let enabledDoNotCreateSpanFlag = hiTraceChain.isFlagEnabled(asyncTraceId, hiTraceChain.HiTraceFlag.DONOT_CREATE_SPAN);
1
2
3
4