Partilhar via

Instrumenter interface

  • Referência
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<xref:TracingSpanContext> num que pode ser utilizado para ligar intervalos não parentais.
startSpan(string, InstrumenterSpanOptions)

Cria um novo TracingSpan com o nome e as opções indicados e define-o num novo contexto.
withContext<CallbackArgs, Callback>(TracingContext, Callback, CallbackArgs)

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

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 o intervalo a serializar.

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<xref:TracingSpanContext> num que pode ser utilizado para ligar intervalos não parentais.

function parseTraceparentHeader(traceparentHeader: string): TracingContext | undefined

Parâmetros

traceparentHeader

string

Devoluções

TracingContext | undefined

startSpan(string, InstrumenterSpanOptions)

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

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

Parâmetros

name

string

O nome do intervalo. Por convenção, deve ser ${className}.${methodName}.

spanOptions
InstrumenterSpanOptions

As opções a utilizar ao criar o intervalo.

Devoluções

{ span: TracingSpan, tracingContext: TracingContext }

Um TracingSpan que pode ser utilizado para terminar o intervalo e o contexto em que este intervalo foi definido.

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

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

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

Parâmetros

context
TracingContext

O TracingContext para utilizar como contexto ativo no âmbito da chamada de retorno.

callback

Callback

A chamada de retorno a invocar com o conjunto de contexto especificado como o contexto globalmente ativo.

callbackArgs

CallbackArgs

Os argumentos de chamada de retorno.

Devoluções

ReturnType<Callback>