Instrumenter interface

Pacote:

@azure/core-tracing

Representa um instrumentador agnóstico de implementação.

Métodos

createRequestHeaders(TracingContext)	Fornece um método específico de implementação para serializar um TracingSpan para um conjunto de cabeçalhos.
parseTraceparentHeader(string)	Fornece um método específico de implementação para analisar um https://www.w3.org/TR/trace-context/#traceparent-header em um <xref:TracingSpanContext> que pode ser usado para vincular extensões não parentais.
startSpan(string, InstrumenterSpanOptions)	Cria um novo TracingSpan com o nome e as opções e o define em um novo contexto.
withContext<CallbackArgs, Callback>(TracingContext, Callback, CallbackArgs)	Encapsula um retorno de chamada com um contexto ativo e chama o retorno de chamada. Dependendo da implementação, isso pode definir o contexto ativo disponível globalmente.

Detalhes de Método

createRequestHeaders(TracingContext)

Fornece um método específico de implementação para serializar um TracingSpan para um conjunto de cabeçalhos.

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

Parâmetros

tracingContext

TracingContext

O contexto que contém a extensão a ser serializada.

Devoluções

Record<string, string>

parseTraceparentHeader(string)

Fornece um método específico de implementação para analisar um https://www.w3.org/TR/trace-context/#traceparent-header em um <xref:TracingSpanContext> que pode ser usado para vincular extensões não parentais.

function parseTraceparentHeader(traceparentHeader: string): undefined | TracingContext

Parâmetros

traceparentHeader

string

Devoluções

undefined | TracingContext

startSpan(string, InstrumenterSpanOptions)

Cria um novo TracingSpan com o nome e as opções e o define em um novo contexto.

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

Parâmetros

name

string

O nome da extensão. Por convenção, isso deve ser ${className}.${methodName}.

spanOptions

InstrumenterSpanOptions

As opções a serem usadas ao criar a extensão.

Devoluções

{ span: TracingSpan, tracingContext: TracingContext }

Um TracingSpan que pode ser usado para encerrar a extensão e o contexto em que essa extensão foi definida.

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

Encapsula um retorno de chamada com um contexto ativo e chama o retorno de chamada. Dependendo da implementação, isso pode definir o contexto ativo disponível globalmente.

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

Parâmetros

context

TracingContext

O TracingContext usar como o contexto ativo no escopo do retorno de chamada.

callback

Callback

O retorno de chamada a ser invocado com o contexto dado definido como o contexto globalmente ativo.

callbackArgs

CallbackArgs

Os argumentos de retorno de chamada.

Devoluções

ReturnType<Callback>