Instrumenter interface

Csomag:

@azure/core-tracing

Implementációs agnosztikus eszközrendszert jelöl.

Metódusok

createRequestHeaders(TracingContext)	Implementációspecifikus módszert biztosít egy TracingSpan fejléckészletre való szerializálásához.
parseTraceparentHeader(string)	Implementációspecifikus módszert biztosít egy https://www.w3.org/TR/trace-context/#traceparent-header egy <xref:TracingSpanContext> való elemzéséhez, amely a nem szülős tartományok összekapcsolására használható.
startSpan(string, InstrumenterSpanOptions)	Létrehoz egy új TracingSpan a megadott névvel és beállításokkal, és beállítja egy új környezetben.
withContext<CallbackArgs, Callback>(TracingContext, Callback, CallbackArgs)	Aktív környezettel burkolja a visszahívást, és meghívja a visszahívást. A megvalósítástól függően ez beállíthatja a globálisan elérhető aktív környezetet.

Metódus adatai

createRequestHeaders(TracingContext)

Implementációspecifikus módszert biztosít egy TracingSpan fejléckészletre való szerializálásához.

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

Paraméterek

tracingContext

TracingContext

A szerializálni kívánt időtartamot tartalmazó környezet.

Válaszok

Record<string, string>

parseTraceparentHeader(string)

Implementációspecifikus módszert biztosít egy https://www.w3.org/TR/trace-context/#traceparent-header egy <xref:TracingSpanContext> való elemzéséhez, amely a nem szülős tartományok összekapcsolására használható.

function parseTraceparentHeader(traceparentHeader: string): undefined | TracingContext

Paraméterek

traceparentHeader

string

Válaszok

undefined | TracingContext

startSpan(string, InstrumenterSpanOptions)

Létrehoz egy új TracingSpan a megadott névvel és beállításokkal, és beállítja egy új környezetben.

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

Paraméterek

name

string

A span neve. Konvenció szerint ennek ${className}.${methodName}kell lennie.

spanOptions

InstrumenterSpanOptions

A hatókör létrehozásakor használandó lehetőségek.

Válaszok

{ span: TracingSpan, tracingContext: TracingContext }

A TracingSpan, amely a span megszüntetésére használható, és a beállítás környezete.

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

Aktív környezettel burkolja a visszahívást, és meghívja a visszahívást. A megvalósítástól függően ez beállíthatja a globálisan elérhető aktív környezetet.

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

Paraméterek

context

TracingContext

A TracingContext a visszahívás hatókörében aktív környezetként használni.

callback

Callback

Az adott környezettel meghívandó visszahívás globálisan aktív környezetként van beállítva.

callbackArgs

CallbackArgs

A visszahívási argumentumok.

Válaszok

ReturnType<Callback>