OpenTelemetryScope class

Pakiet:
@microsoft/agents-a365-observability

Klasa bazowa dla zakresów śledzenia OpenTelemetry

Metody

dispose()

Starsza metoda usuwania pod kątem zgodności
getSpanContext()

Pobiera kontekst zakresu dla tego zakresu. Można go użyć do utworzenia elementu ParentSpanRef do jawnego łączenia elementów nadrzędny-podrzędny w granicach asynchronicznych.
recordAttributes(undefined | null | Iterable<[string, AttributeValue]> | Record<string, AttributeValue>)

Rejestruje wiele par klucz/wartość atrybutu na potrzeby śledzenia telemetrii.
recordCancellation(string)

Rejestruje zdarzenie anulowania w zakresie. Ustawia stan zakresu na ERROR z przyczyną anulowania i oznacza typ błędu jako "TaskCanceledException".
recordError(Error)

Rejestruje błąd, który wystąpił podczas operacji
setEndTime(TimeInput)

Ustawia niestandardowy czas zakończenia dla zakresu. Po ustawieniu metoda dispose przekaże tę wartość zamiast używać span.end() bieżącego czasu zegara ściany. Jest to przydatne, gdy rzeczywisty czas zakończenia operacji jest znany przed usunięciem zakresu.
withActiveSpanAsync<T>(() => Promise<T>)

Powoduje, że ten zakres jest aktywny przez czas trwania wykonywania wywołania zwrotnego asynchronicznego

Szczegóły metody

dispose()

Starsza metoda usuwania pod kątem zgodności

function dispose()

getSpanContext()

Pobiera kontekst zakresu dla tego zakresu. Można go użyć do utworzenia elementu ParentSpanRef do jawnego łączenia elementów nadrzędny-podrzędny w granicach asynchronicznych.

function getSpanContext(): SpanContext

Zwraca

SpanContext

Plik SpanContext zawierający traceId i spanId

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

Rejestruje wiele par klucz/wartość atrybutu na potrzeby śledzenia telemetrii.

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

Parametry

attributes

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

Kolekcja par klucz/wartość atrybutu (tablica lub iterable [klucz, wartość] lub mapa obiektu).

recordCancellation(string)

Rejestruje zdarzenie anulowania w zakresie. Ustawia stan zakresu na ERROR z przyczyną anulowania i oznacza typ błędu jako "TaskCanceledException".

function recordCancellation(reason?: string)

Parametry

reason

string

Opcjonalna przyczyna anulowania. Wartość domyślna to "Zadanie zostało anulowane".

recordError(Error)

Rejestruje błąd, który wystąpił podczas operacji

function recordError(error: Error)

Parametry

error

Error

Błąd, który się pojawił

setEndTime(TimeInput)

Ustawia niestandardowy czas zakończenia dla zakresu. Po ustawieniu metoda dispose przekaże tę wartość zamiast używać span.end() bieżącego czasu zegara ściany. Jest to przydatne, gdy rzeczywisty czas zakończenia operacji jest znany przed usunięciem zakresu.

function setEndTime(endTime: TimeInput)

Parametry

endTime

TimeInput

Godzina zakończenia w milisekundach od epoki, daty lub krotki HrTime.

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

Powoduje, że ten zakres jest aktywny przez czas trwania wykonywania wywołania zwrotnego asynchronicznego

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

Parametry

callback

() => Promise<T>

Zwraca

Promise<T>