OpenTelemetryScope class

Pacchetto:

@microsoft/agents-a365-observability

Classe base per gli ambiti di traccia OpenTelemetry

Metodi

dispose()	Metodo dispose legacy per la compatibilità
getSpanContext()	Ottiene il contesto dell'intervallo per questo ambito. Può essere usato per creare un elemento ParentSpanRef per il collegamento esplicito padre-figlio attraverso i limiti asincroni.
recordAttributes(undefined | null | Iterable<[string, AttributeValue]> | Record<string, AttributeValue>)	Registra più coppie chiave/valore di attributo per il rilevamento dei dati di telemetria.
recordCancellation(string)	Registra un evento di annullamento nell'intervallo. Imposta lo stato dell'intervallo su ERROR con il motivo dell'annullamento e contrassegna il tipo di errore come 'TaskCanceledException'.
recordError(Error)	Registra un errore che si è verificato durante l'operazione
setEndTime(TimeInput)	Imposta un'ora di fine personalizzata per l'ambito. Se impostato, dispose passerà questo valore a span.end() invece di usare l'ora corrente. Ciò è utile quando l'ora di fine effettiva dell'operazione è nota prima dell'eliminazione dell'ambito.
withActiveSpanAsync<T>(() => Promise<T>)	Rende attivo questo intervallo per la durata dell'esecuzione del callback asincrono

Dettagli metodo

dispose()

Metodo dispose legacy per la compatibilità

function dispose()

getSpanContext()

Ottiene il contesto dell'intervallo per questo ambito. Può essere usato per creare un elemento ParentSpanRef per il collegamento esplicito padre-figlio attraverso i limiti asincroni.

function getSpanContext(): SpanContext

Valori restituiti

SpanContext

SpanContext contenente traceId e spanId

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

Registra più coppie chiave/valore di attributo per il rilevamento dei dati di telemetria.

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

Parametri

attributes

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

Raccolta di coppie chiave/valore dell'attributo (matrice o iterabile di [chiave, valore] o mappa oggetti).

recordCancellation(string)

Registra un evento di annullamento nell'intervallo. Imposta lo stato dell'intervallo su ERROR con il motivo dell'annullamento e contrassegna il tipo di errore come 'TaskCanceledException'.

function recordCancellation(reason?: string)

Parametri

reason

string

Motivo di annullamento facoltativo. L'impostazione predefinita è 'Task was cancelled'.

recordError(Error)

Registra un errore che si è verificato durante l'operazione

function recordError(error: Error)

Parametri

error

Error

L'errore che si è verificato

setEndTime(TimeInput)

Imposta un'ora di fine personalizzata per l'ambito. Se impostato, dispose passerà questo valore a span.end() invece di usare l'ora corrente. Ciò è utile quando l'ora di fine effettiva dell'operazione è nota prima dell'eliminazione dell'ambito.

function setEndTime(endTime: TimeInput)

Parametri

endTime

TimeInput

Ora di fine come millisecondi dall'epoca, da una tupla Date o HrTime.

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

Rende attivo questo intervallo per la durata dell'esecuzione del callback asincrono

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

Parametri

callback

() => Promise<T>

Valori restituiti

Promise<T>