TracingClient interface

Pakket:

@azure/core-tracing

Vertegenwoordigt een client die kan worden geïntegreerd met de momenteel geconfigureerde Instrumenter.

Maak een exemplaar met createTracingClient.

Methoden

createRequestHeaders(TracingContext)	Hiermee maakt u een set aanvraagheaders om traceringsgegevens door te geven aan een back-end.
parseTraceparentHeader(string)	Parseert een traceringswaarde van de header in een <xref:TracingSpanContext>.
startSpan<Options>(string, Options, TracingSpanOptions)	Hiermee wordt een bepaalde periode gestart, maar niet ingesteld als de actieve periode. U moet de periode beëindigen met behulp van end. Meestal wilt u in plaats daarvan metSpan gebruiken.
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. Dit is handig als u de grenzen van de SDK wilt verlaten (een aanvraag of callback naar gebruikerscode doen) en de api withSpan niet kunt gebruiken.
withSpan<Options, Callback>(string, Options, Callback, TracingSpanOptions)	Verpakt een callback in een traceringsbereik, roept de callback aan en sluit de span. Dit is de primaire interface voor het gebruik van Tracering en verwerkt het opnemen van fouten en het instellen van de status op het bereik. Zowel synchrone als asynchrone functies worden gewacht om het resultaat van de callback op de span weer te geven. Voorbeeld: const myOperationResult = await tracingClient.withSpan("myClassName.myOperationName", options, (updatedOptions) => myOperation(updatedOptions));

Methodedetails

createRequestHeaders(TracingContext)

Hiermee maakt u een set aanvraagheaders om traceringsgegevens door te geven aan een back-end.

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

Parameters

tracingContext

TracingContext

De context met de span die moet worden doorgegeven.

Retouren

Record<string, string>

De set headers die aan een aanvraag moet worden toegevoegd.

parseTraceparentHeader(string)

Parseert een traceringswaarde van de header in een <xref:TracingSpanContext>.

function parseTraceparentHeader(traceparentHeader: string): undefined | TracingContext

Parameters

traceparentHeader

string

De traceparent-header die moet worden geparseerd.

Retouren

undefined | TracingContext

Een implementatiespecifieke id voor de periode.

startSpan<Options>(string, Options, TracingSpanOptions)

Hiermee wordt een bepaalde periode gestart, maar niet ingesteld als de actieve periode.

U moet de periode beëindigen met behulp van end.

Meestal wilt u in plaats daarvan metSpan gebruiken.

function startSpan<Options>(name: string, operationOptions?: Options, spanOptions?: TracingSpanOptions): { span: TracingSpan, updatedOptions: OptionsWithTracingContext<Options> }

Parameters

name

string

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

operationOptions

Options

De oorspronkelijke bewerkingsopties.

spanOptions

TracingSpanOptions

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

Retouren

{ span: TracingSpan, updatedOptions: OptionsWithTracingContext<Options> }

Een TracingSpan en de bijgewerkte bewerkingsopties.

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.

Dit is handig als u de grenzen van de SDK wilt verlaten (een aanvraag of callback naar gebruikerscode doen) en de api withSpan niet kunt gebruiken.

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>

withSpan<Options, Callback>(string, Options, Callback, TracingSpanOptions)

Verpakt een callback in een traceringsbereik, roept de callback aan en sluit de span.

Dit is de primaire interface voor het gebruik van Tracering en verwerkt het opnemen van fouten en het instellen van de status op het bereik.

Zowel synchrone als asynchrone functies worden gewacht om het resultaat van de callback op de span weer te geven.

Voorbeeld:

const myOperationResult = await tracingClient.withSpan("myClassName.myOperationName", options, (updatedOptions) => myOperation(updatedOptions));

function withSpan<Options, Callback>(name: string, operationOptions: Options, callback: Callback, spanOptions?: TracingSpanOptions): Promise<Resolved<ReturnType<Callback>>>

Parameters

name

string

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

operationOptions

Options

De oorspronkelijke opties die zijn doorgegeven aan de methode. De callback ontvangt deze opties met de zojuist gemaakte TracingContext.

callback

Callback

De callback die moet worden aangeroepen met de bijgewerkte opties en de zojuist gemaakte TracingSpan.

spanOptions

TracingSpanOptions

Retouren

Promise<Resolved<ReturnType<Callback>>>