OpenTelemetryScope class

Pacote:

@microsoft/agents-a365-observability

Classe base para escopos de rastreio OpenTelemetry

Métodos

dispose()	Método de descarte legado para compatibilidade
getSpanContext()	Obtém o contexto de extensão para este telescópio. Isto pode ser usado para criar um ParentSpanRef para ligações explícitas pai-filho através de fronteiras assíncronas.
recordAttributes(undefined | null | Iterable<[string, AttributeValue]> | Record<string, AttributeValue>)	Grava múltiplos pares chave/valor de atributos para rastreamento de telemetria.
recordCancellation(string)	Regista um evento de cancelamento durante a travessia. Define o estado do span para ERRO com a razão do cancelamento e marca o tipo de erro como 'TaskCanceledException'.
recordError(Error)	Regista um erro ocorrido durante a operação
setEndTime(TimeInput)	Define uma hora de fim personalizada para o telescópio. Quando definido, descarte transmite este valor para span.end() em vez de usar o tempo atual do relógio de parede. Isto é útil quando a hora real de fim da operação é conhecida antes do escopo.
withActiveSpanAsync<T>(() => Promise<T>)	Torna este intervalo ativo durante toda a execução do callback assíncrono

Detalhes de Método

dispose()

Método de descarte legado para compatibilidade

function dispose()

getSpanContext()

Obtém o contexto de extensão para este telescópio. Isto pode ser usado para criar um ParentSpanRef para ligações explícitas pai-filho através de fronteiras assíncronas.

function getSpanContext(): SpanContext

Devoluções

SpanContext

O SpanContext contendo traceId e spanId

recordAttributes(undefined | null | Iterable<[string, AttributeValue]> | Record<string, AttributeValue>)

Grava múltiplos pares chave/valor de atributos para rastreamento de telemetria.

function recordAttributes(attributes: undefined | null | Iterable<[string, AttributeValue]> | Record<string, AttributeValue>)

Parâmetros

attributes

undefined | null | Iterable<[string, AttributeValue]> | Record<string, AttributeValue>

Coleção de pares chave/valor de atributos (array ou iterável de [chave, valor] ou mapa de objetos).

recordCancellation(string)

Regista um evento de cancelamento durante a travessia. Define o estado do span para ERRO com a razão do cancelamento e marca o tipo de erro como 'TaskCanceledException'.

function recordCancellation(reason?: string)

Parâmetros

reason

string

Motivo opcional de cancelamento. Por defeito, 'Tarefa foi cancelada'.

recordError(Error)

Regista um erro ocorrido durante a operação

function recordError(error: Error)

Parâmetros

error

Error

O erro que ocorreu

setEndTime(TimeInput)

Define uma hora de fim personalizada para o telescópio. Quando definido, descarte transmite este valor para span.end() em vez de usar o tempo atual do relógio de parede. Isto é útil quando a hora real de fim da operação é conhecida antes do escopo.

function setEndTime(endTime: TimeInput)

Parâmetros

endTime

TimeInput

O tempo de fim em milissegundos desde a época, uma Data ou uma tupla HrTime.

withActiveSpanAsync<T>(() => Promise<T>)

Torna este intervalo ativo durante toda a execução do callback assíncrono

function withActiveSpanAsync<T>(callback: () => Promise<T>): Promise<T>

Parâmetros

callback

() => Promise<T>

Devoluções

Promise<T>