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>

共用方式為