Instrumenter interface

Pakket:

@azure/core-tracing

Vertegenwoordigt een implementatieagnostische instrumenteerfunctie.

Methoden

createRequestHeaders(TracingContext)	Biedt een implementatiespecifieke methode om een TracingSpan te serialiseren naar een set headers.
parseTraceparentHeader(string)	Biedt een implementatiespecifieke methode voor het parseren van een https://www.w3.org/TR/trace-context/#traceparent-header in een <xref:TracingSpanContext> die kan worden gebruikt om niet-bovenliggende spanten aan elkaar te koppelen.
startSpan(string, InstrumenterSpanOptions)	Hiermee maakt u een nieuwe TracingSpan met de opgegeven naam en opties en stelt u deze in op een nieuwe context.
withContext<CallbackArgs, Callback>(TracingContext, Callback, CallbackArgs)	Verpakt een callback met een actieve context en roept de callback aan. Afhankelijk van de implementatie kan hiermee de wereldwijd beschikbare actieve context worden ingesteld.

Methodedetails

createRequestHeaders(TracingContext)

Biedt een implementatiespecifieke methode om een TracingSpan te serialiseren naar een set headers.

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

Parameters

tracingContext

TracingContext

De context met de span die moet worden geserialiseerd.

Retouren

Record<string, string>

parseTraceparentHeader(string)

Biedt een implementatiespecifieke methode voor het parseren van een https://www.w3.org/TR/trace-context/#traceparent-header in een <xref:TracingSpanContext> die kan worden gebruikt om niet-bovenliggende spanten aan elkaar te koppelen.

function parseTraceparentHeader(traceparentHeader: string): TracingContext | undefined

Parameters

traceparentHeader

string

Retouren

TracingContext | undefined

startSpan(string, InstrumenterSpanOptions)

Hiermee maakt u een nieuwe TracingSpan met de opgegeven naam en opties en stelt u deze in op een nieuwe context.

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

Parameters

name

string

De naam van de span. Volgens de conventie moet dit zijn ${className}.${methodName}.

spanOptions

InstrumenterSpanOptions

De opties die moeten worden gebruikt bij het maken van de span.

Retouren

{ span: TracingSpan, tracingContext: TracingContext }

Een TracingSpan die kan worden gebruikt om de periode te beëindigen en de context waarop deze periode is ingesteld.

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

Verpakt een callback met een actieve context en roept de callback aan. Afhankelijk van de implementatie kan hiermee de wereldwijd beschikbare actieve context worden ingesteld.

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

Parameters

context

TracingContext

De TracingContext die moet worden gebruikt als de actieve context in het bereik van de callback.

callback

Callback

De callback die moet worden aangeroepen met de opgegeven context ingesteld als de globaal actieve context.

callbackArgs

CallbackArgs

De callback-argumenten.

Retouren

ReturnType<Callback>