Freigeben über

OpenTelemetryScope class

Paket:
@microsoft/agents-a365-observability

Basisklasse für OpenTelemetry-Ablaufverfolgungsbereiche

Methoden

dispose()

Legacy-Dispose-Methode zur Kompatibilität
getSpanContext()

Ruft den Span-Kontext für diesen Bereich ab. Dies kann verwendet werden, um eine ParentSpanRef für explizite verknüpfung zwischen übergeordneten und untergeordneten Elementen über asynchrone Grenzen hinweg zu erstellen.
recordAttributes(undefined | null | Iterable<[string, AttributeValue]> | Record<string, AttributeValue>)

Zeichnet mehrere Attributschlüssel-Wert-Paare für die Telemetrienachverfolgung auf.
recordCancellation(string)

Zeichnet ein Abbruchereignis auf der Spanne auf. Legt den Span-Status auf ERROR mit dem Abbruchgrund fest und markiert den Fehlertyp als "TaskCanceledException".
recordError(Error)

Zeichnet einen Fehler auf, der während des Vorgangs aufgetreten ist.
setEndTime(TimeInput)

Legt eine benutzerdefinierte Endzeit für den Bereich fest. Wenn dieser Wert festgelegt ist, übergibt Dispose diesen Wert span.end() anstelle der aktuellen Zeit für die Wanduhr. Dies ist nützlich, wenn die tatsächliche Endzeit des Vorgangs bekannt ist, bevor der Bereich verworfen wird.
withActiveSpanAsync<T>(() => Promise<T>)

Macht diese Spanne für die Dauer der asynchronen Rückrufausführung aktiv

Details zur Methode

dispose()

Legacy-Dispose-Methode zur Kompatibilität

function dispose()

getSpanContext()

Ruft den Span-Kontext für diesen Bereich ab. Dies kann verwendet werden, um eine ParentSpanRef für explizite verknüpfung zwischen übergeordneten und untergeordneten Elementen über asynchrone Grenzen hinweg zu erstellen.

function getSpanContext(): SpanContext

Gibt zurück

SpanContext

Der SpanContext mit traceId und spanId

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

Zeichnet mehrere Attributschlüssel-Wert-Paare für die Telemetrienachverfolgung auf.

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

Parameter

attributes

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

Auflistung von Attributschlüssel-Wert-Paaren (Array oder iterierbar von [Schlüssel, Wert] oder Objektzuordnung).

recordCancellation(string)

Zeichnet ein Abbruchereignis auf der Spanne auf. Legt den Span-Status auf ERROR mit dem Abbruchgrund fest und markiert den Fehlertyp als "TaskCanceledException".

function recordCancellation(reason?: string)

Parameter

reason

string

Optionaler Abbruchgrund. Der Standardwert ist "Vorgang wurde abgebrochen".

recordError(Error)

Zeichnet einen Fehler auf, der während des Vorgangs aufgetreten ist.

function recordError(error: Error)

Parameter

error

Error

Der Fehler, der aufgetreten ist

setEndTime(TimeInput)

Legt eine benutzerdefinierte Endzeit für den Bereich fest. Wenn dieser Wert festgelegt ist, übergibt Dispose diesen Wert span.end() anstelle der aktuellen Zeit für die Wanduhr. Dies ist nützlich, wenn die tatsächliche Endzeit des Vorgangs bekannt ist, bevor der Bereich verworfen wird.

function setEndTime(endTime: TimeInput)

Parameter

endTime

TimeInput

Die Endzeit als Millisekunden seit Epoche, Datum oder HrTime-Tupel.

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

Macht diese Spanne für die Dauer der asynchronen Rückrufausführung aktiv

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

Parameter

callback

() => Promise<T>

Gibt zurück

Promise<T>