分布式跟踪

2024-01-23 17:19 更新

本模块提供了端侧业务流程调用链跟踪的打点能力,包括业务流程跟踪的启动、结束、信息埋点等能力。

说明

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

导入模块

  1. import hiTraceChain from '@ohos.hiTraceChain';

HiTraceFlag

跟踪标志组合类型枚举。

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

名称说明
DEFAULT0缺省标志。
INCLUDE_ASYNC1异步调用标志。启动跟踪时,缺省只跟踪同步调用。设置该标志,同时跟踪同步、异步调用。
DONOT_CREATE_SPAN1 << 1无分支标志。启动跟踪时,在同步、异步调用时缺省自动创建分支信息。设置该标志,指示不创建分支。
TP_INFO1 << 2埋点标志。启动跟踪式时,缺省不进行埋点。调试场景下设置该标志,在同步、异步调用的收发侧自动埋点,输出埋点信息和时间戳。收发埋点按照client、server分为client send(CS)、server receive(SR)、server send(SS)、client receive(CR)四类信息。一次同步调用输出CS/SR/SS/CR,一次异步调用输出CS/SR/SS三个埋点信息。
NO_BE_INFO1 << 3无起始结束标志。启动跟踪时,缺省打印启动及结束跟踪信息。设置该标志,指示不打印启动及结束跟踪信息。
DISABLE_LOG1 << 4日志关联标志。设置该标志,指示隐藏日志中的跟踪信息。
FAILURE_TRIGGER1 << 5故障触发标志。预置标志,暂时没有作用。
D2D_TP_INFO1 << 6设备间埋点标志。TP_INFO的一个子集,设置该标志,只进行设备间的调用埋点。

HiTraceTracepointType

跟踪埋点类型枚举。

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

名称说明
CS0客户端发送类型,标识client侧的发送埋点。
CR1客户端接收类型,标识client侧的接收埋点。
SS2服务端发送类型,标识server侧的发送埋点。
SR3服务端接收类型,标识server侧的接收埋点。
GENERAL4一般类型,标识CS、CR、SS、SR四种场景之外的埋点。

HiTraceCommunicationMode

跟踪通信类型枚举。

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

名称说明
DEFAULT0缺省通信类型
THREAD1线程间通信类型
PROCESS2进程间通信类型
DEVICE3设备间通信类型

HiTraceId

此接口为HiTraceId对象接口。

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

名称类型必填说明
chainIdbigint跟踪链标识。
spanIdnumber分支标识。
parentSpanIdnumber父分支标识。
flagsnumber跟踪标志组合。

hiTraceChain.begin

begin(name: string, flags?: number): HiTraceId

开始跟踪,同步接口。

系统能力: SystemCapability.HiviewDFX.HiTrace

参数:

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

返回值:

类型说明
HiTraceIdHiTraceId实例。

示例:

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

hiTraceChain.end

end(id: HiTraceId): void

结束跟踪,同步接口。

系统能力: SystemCapability.HiviewDFX.HiTrace

参数:

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

示例:

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

hiTraceChain.getId

getId(): HiTraceId

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

系统能力: SystemCapability.HiviewDFX.HiTrace

返回值:

类型说明
HiTraceIdHiTraceId实例。

示例:

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

hiTraceChain.setId

setId(id: HiTraceId): void

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

系统能力: SystemCapability.HiviewDFX.HiTrace

参数:

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

示例:

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

hiTraceChain.clearId

clearId(): void

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

系统能力: SystemCapability.HiviewDFX.HiTrace

示例:

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

hiTraceChain.createSpan

createSpan(): HiTraceId

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

系统能力: SystemCapability.HiviewDFX.HiTrace

返回值:

类型说明
HiTraceIdHiTraceId实例。

示例:

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

hiTraceChain.tracepoint

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

信息埋点,同步接口。

系统能力: SystemCapability.HiviewDFX.HiTrace

参数:

参数名类型必填说明
modeHiTraceCommunicationMode信息埋点需要指定的跟踪通信模式。
typeHiTraceTracepointType信息埋点需要指定的跟踪埋点类型。
idHiTraceId实施信息埋点操作的HiTraceId实例。
msgstring信息埋点操作传入的trace说明信息。

示例:

  1. let asyncTraceId = hiTraceChain.begin("business", hiTraceChain.HiTraceFlag.INCLUDE_ASYNC | hiTraceChain.HiTraceFlag.DONOT_CREATE_SPAN);
  2. // 若干业务逻辑完成后,触发信息埋点操作。
  3. hiTraceChain.tracepoint(hiTraceChain.HiTraceCommunicationMode.THREAD, hiTraceChain.HiTraceTracepointType.SS, asyncTraceId, "Just a example");

hiTraceChain.isValid

isValid(id: HiTraceId): boolean

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

系统能力: SystemCapability.HiviewDFX.HiTrace

参数:

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

返回值:

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

示例:

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

hiTraceChain.isFlagEnabled

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

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

系统能力: SystemCapability.HiviewDFX.HiTrace

参数:

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

返回值:

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

示例:

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

hiTraceChain.enableFlag

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

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

系统能力: SystemCapability.HiviewDFX.HiTrace

参数:

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

示例:

  1. let asyncTraceId = hiTraceChain.begin("business", hiTraceChain.HiTraceFlag.INCLUDE_ASYNC);
  2. hiTraceChain.enableFlag(asyncTraceId, hiTraceChain.HiTraceFlag.DONOT_CREATE_SPAN);
  3. // enabledDoNotCreateSpanFlag为true
  4. let enabledDoNotCreateSpanFlag = hiTraceChain.isFlagEnabled(asyncTraceId, hiTraceChain.HiTraceFlag.DONOT_CREATE_SPAN);
以上内容是否对您有帮助:
在线笔记
App下载
App下载

扫描二维码

下载编程狮App

公众号
微信公众号

编程狮公众号