你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

Instrumenter interface

参考

包:: @azure/core-tracing

表示与实现无关的检测程序。

方法

createRequestHeaders(TracingContext)	提供特定于实现的方法，用于将 TracingSpan 序列化为一组标头。
parseTraceparentHeader(string)	提供一种特定于实现的方法，用于将解析 https://www.w3.org/TR/trace-context/#traceparent-header 为 <xref:TracingSpanContext> 可用于将非父级跨度链接在一起的。
startSpan(string, InstrumenterSpanOptions)	使用给定名称和选项创建新的 TracingSpan ，并在新上下文中设置它。
withContext<CallbackArgs, Callback>(TracingContext, Callback, CallbackArgs)	使用活动上下文包装回调并调用回调。根据实现，这可能会设置全局可用的活动上下文。

方法详细信息

createRequestHeaders(TracingContext)

提供特定于实现的方法，用于将 TracingSpan 序列化为一组标头。

function createRequestHeaders(tracingContext?: TracingContext): Record<string, string>

参数

tracingContext: TracingContext

包含要序列化的跨度的上下文。

Record<string, string>

parseTraceparentHeader(string)

提供一种特定于实现的方法，用于将解析 https://www.w3.org/TR/trace-context/#traceparent-header 为 <xref:TracingSpanContext> 可用于将非父级跨度链接在一起的。

function parseTraceparentHeader(traceparentHeader: string): undefined | TracingContext

参数

traceparentHeader: string

undefined | TracingContext

startSpan(string, InstrumenterSpanOptions)

使用给定名称和选项创建新的 TracingSpan ，并在新上下文中设置它。

function startSpan(name: string, spanOptions: InstrumenterSpanOptions): { span: TracingSpan, tracingContext: TracingContext }

参数

name: string

范围的名称。按照约定，此应为 ${className}.${methodName}。

spanOptions: InstrumenterSpanOptions

创建范围时要使用的选项。

{ span: TracingSpan, tracingContext: TracingContext }

一个 TracingSpan ，可用于结束范围，以及已设置此跨度的上下文。

withContext<CallbackArgs, Callback>(TracingContext, Callback, CallbackArgs)

使用活动上下文包装回调并调用回调。根据实现，这可能会设置全局可用的活动上下文。

function withContext<CallbackArgs, Callback>(context: TracingContext, callback: Callback, callbackArgs: CallbackArgs): ReturnType<Callback>

参数

context: TracingContext

在回调范围内用作活动上下文的 TracingContext 。

callback: Callback

要调用的回调，给定的上下文设置为全局活动上下文。

callbackArgs: CallbackArgs

回调参数。

ReturnType<Callback>

通过