公司网站怎么做关键字,网站建设介绍文字,微信小程序api文档,wordpress自动生成缩略图分布式跟踪
本模块提供了端侧业务流程调用链跟踪的打点能力#xff0c;包括业务流程跟踪的启动、结束、信息埋点等能力。 说明#xff1a; 本模块首批接口从API version 8开始支持。后续版本的新增接口#xff0c;采用上角标单独标记接口的起始版本。 导入模块
import hi…分布式跟踪
本模块提供了端侧业务流程调用链跟踪的打点能力包括业务流程跟踪的启动、结束、信息埋点等能力。 说明 本模块首批接口从API version 8开始支持。后续版本的新增接口采用上角标单独标记接口的起始版本。 导入模块
import hiTraceChain from ohos.hiTraceChain;HiTraceFlag
跟踪标志组合类型枚举。
系统能力 以下各项对应的系统能力均为SystemCapability.HiviewDFX.HiTrace。
名称默认值说明DEFAULT0缺省标志。INCLUDE_ASYNC1异步调用标志。启动跟踪时缺省只跟踪同步调用。设置该标志同时跟踪同步、异步调用。DONOT_CREATE_SPAN1 1无分支标志。启动跟踪时在同步、异步调用时缺省自动创建分支信息。设置该标志指示不创建分支。TP_INFO1 2埋点标志。启动跟踪式时缺省不进行埋点。调试场景下设置该标志在同步、异步调用的收发侧自动埋点输出埋点信息和时间戳。收发埋点按照client、server分为[client sendCS、server receiveSR、server sendSS、client receiveCR]四类信息。一次同步调用输出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 HiTraceFlag.DEFAULT): HiTraceId
开始跟踪同步接口。
系统能力 SystemCapability.HiviewDFX.HiTrace
参数
参数名类型必填说明namestring是跟踪业务名。flagsnumber是跟踪标志组合具体可参考[HiTraceFlag]
返回值
类型说明[HiTraceId]HiTraceId实例。
示例
let asyncTraceId hiTraceChain.begin(business, hiTraceChain.HiTraceFlag.INCLUDE_ASYNC | hiTraceChain.HiTraceFlag.DONOT_CREATE_SPAN);hiTraceChain.end
end(id: HiTraceId): void
结束跟踪同步接口。
系统能力 SystemCapability.HiviewDFX.HiTrace
参数
参数名类型必填说明id[HiTraceId]是HiTraceId实例。
示例
let asyncTraceId hiTraceChain.begin(business);
// 若干业务逻辑完成后结束跟踪。
hiTraceChain.end(asyncTraceId);hiTraceChain.getId
getId(): HiTraceId
获取跟踪标识同步接口。
系统能力 SystemCapability.HiviewDFX.HiTrace
返回值
类型说明[HiTraceId]HiTraceId实例。
示例
let traceId hiTraceChain.begin(business);
// 若干业务逻辑完成后获取当前HiTraceId。
let curTraceId hiTraceChain.getId();hiTraceChain.setId
setId(id: HiTraceId): void
设置跟踪标识同步接口。
系统能力 SystemCapability.HiviewDFX.HiTrace
参数
参数名类型必填说明id[HiTraceId]是HiTraceId实例。
示例
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
返回值
类型说明[HiTraceId]HiTraceId实例。
示例
let traceId hiTraceChain.begin(business);
// 若干业务逻辑完成后创建跟踪分支。
let spanTraceId hiTraceChain.createSpan();hiTraceChain.tracepoint
tracepoint(mode: HiTraceCommunicationMode, type: HiTraceTracepointType, id: HiTraceId, msg?: string): void
信息埋点同步接口。
系统能力 SystemCapability.HiviewDFX.HiTrace
参数
参数名类型必填说明mode[HiTraceCommunicationMode]是信息埋点需要指定的跟踪通信模式。type[HiTraceTracepointType]是信息埋点需要指定的跟踪埋点类型。id[HiTraceId]是实施信息埋点操作的HiTraceId实例。msgstring否信息埋点操作传入的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);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);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);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.enableFlag(asyncTraceId, hiTraceChain.HiTraceFlag.DONOT_CREATE_SPAN);
// enabledDoNotCreateSpanFlag为true
let enabledDoNotCreateSpanFlag hiTraceChain.isFlagEnabled(asyncTraceId, hiTraceChain.HiTraceFlag.DONOT_CREATE_SPAN);