分布式跟蹤

本模塊提供了端側業務流程調用鏈跟蹤的打點能力，包括業務流程跟蹤的啟動、結束、信息埋點等能力。

說明： 本模塊首批接口從API version 8開始支持。后續版本的新增接口，采用上角標單獨標記接口的起始版本。 開發前請熟悉鴻蒙開發指導文檔 ：[gitee.com/li-shizhen-skin/harmony-os/blob/master/README.md]

導入模塊

import hiTraceChain from '@ohos.hiTraceChain';

HiTraceFlag

跟蹤標志組合類型枚舉。

系統能力： 以下各項對應的系統能力均為SystemCapability.HiviewDFX.HiTrace。

HiTraceTracepointType

跟蹤埋點類型枚舉。

系統能力： 以下各項對應的系統能力均為SystemCapability.HiviewDFX.HiTrace。

HiTraceCommunicationMode

跟蹤通信類型枚舉。

系統能力： 以下各項對應的系統能力均為SystemCapability.HiviewDFX.HiTrace。

HiTraceId

此接口為HiTraceId對象接口。

系統能力： 以下各項對應的系統能力均為SystemCapability.HiviewDFX.HiTrace。

hiTraceChain.begin

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

開始跟蹤，同步接口。

系統能力： SystemCapability.HiviewDFX.HiTrace

參數：

返回值：

示例：

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

hiTraceChain.end

end(id: HiTraceId): void

結束跟蹤，同步接口。

系統能力： SystemCapability.HiviewDFX.HiTrace

參數：

示例：

let asyncTraceId = hiTraceChain.begin("business");
// 若干業務邏輯完成后，結束跟蹤。
hiTraceChain.end(asyncTraceId);

hiTraceChain.getId

getId(): HiTraceId

獲取跟蹤標識，同步接口。

系統能力： SystemCapability.HiviewDFX.HiTrace

返回值：

示例：

let traceId = hiTraceChain.begin("business");
// 若干業務邏輯完成后，獲取當前HiTraceId。
let curTraceId = hiTraceChain.getId();

hiTraceChain.setId

setId(id: HiTraceId): void

設置跟蹤標識，同步接口。

系統能力： SystemCapability.HiviewDFX.HiTrace

參數：

示例：

let asyncTraceId;
let traceId = hiTraceChain.begin("business");
// 若干業務邏輯完成后，設置當前HiTraceId。
hiTraceChain.setId(asyncTraceId);

hiTraceChain.clearId

clearId(): void

清除跟蹤標識，同步接口。

系統能力： SystemCapability.HiviewDFX.HiTrace

示例：

let traceId = hiTraceChain.begin("business");
// 若干業務邏輯完成后，清除當前HiTraceId。
hiTraceChain.clearId();

hiTraceChain.createSpan

createSpan(): HiTraceId

創建跟蹤分支，同步接口。

系統能力： SystemCapability.HiviewDFX.HiTrace

返回值：

示例：

let traceId = hiTraceChain.begin("business");
// 若干業務邏輯完成后，創建跟蹤分支。
let spanTraceId = hiTraceChain.createSpan();

hiTraceChain.tracepoint

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

信息埋點，同步接口。

系統能力： SystemCapability.HiviewDFX.HiTrace

參數：

示例：

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.isValid

isValid(id: HiTraceId): boolean

判斷HiTraceId對象是否有效，同步接口。

系統能力： SystemCapability.HiviewDFX.HiTrace

參數：

返回值：

示例：

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

hiTraceChain.isFlagEnabled

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

判斷HiTraceId對象中指定的跟蹤標志是否已置位，同步接口。

系統能力： SystemCapability.HiviewDFX.HiTrace

參數：

返回值：

示例：

let asyncTraceId = hiTraceChain.begin("business", hiTraceChain.HiTraceFlag.INCLUDE_ASYNC);
// enabledDoNotCreateSpanFlag為true
let enabledDoNotCreateSpanFlag = hiTraceChain.isFlagEnabled(asyncTraceId, hiTraceChain.HiTraceFlag.INCLUDE_ASYNC);

hiTraceChain.enableFlag

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

置位HiTraceId對象中指定的跟蹤標志，同步接口。

系統能力： SystemCapability.HiviewDFX.HiTrace

參數：

示例：

let asyncTraceId = hiTraceChain.begin("business", hiTraceChain.HiTraceFlag.INCLUDE_ASYNC);
hiTraceChain.enableFlag(asyncTraceId, hiTraceChain.HiTraceFlag.DONOT_CREATE_SPAN);
// enabledDoNotCreateSpanFlag為true
let enabledDoNotCreateSpanFlag = hiTraceChain.isFlagEnabled(asyncTraceId, hiTraceChain.HiTraceFlag.DONOT_CREATE_SPAN);

審核編輯 黃宇