OutputScope class

Pakiet:

@microsoft/agents-a365-observability

Zapewnia zakres śledzenia openTelemetry dla śledzenia komunikatów wyjściowych z nadrzędnym łączeniem zakresu.

Rozszerzenie

OpenTelemetryScope

Metody

recordOutputMessages(ResponseMessagesParam)

Rejestruje komunikaty wyjściowe na potrzeby śledzenia danych telemetrycznych. Zastępuje wszystkie wcześniej zarejestrowane komunikaty wyjściowe w zakresie. Akceptuje pojedynczy ciąg, tablicę ciągów (automatycznie opakowanych jako OTEL OutputMessage), wersję otoki OutputMessages lub nieprzetworzonego dyktu (traktowanego jako wynik wywołania narzędzia dla specyfikacji OTEL, serializowane bezpośrednio).

start(Request, OutputResponse, AgentDetails, UserDetails, SpanDetails)

Tworzy i uruchamia nowy zakres śledzenia komunikatów wyjściowych.

Metody dziedziczone

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

recordOutputMessages(ResponseMessagesParam)

Rejestruje komunikaty wyjściowe na potrzeby śledzenia danych telemetrycznych. Zastępuje wszystkie wcześniej zarejestrowane komunikaty wyjściowe w zakresie. Akceptuje pojedynczy ciąg, tablicę ciągów (automatycznie opakowanych jako OTEL OutputMessage), wersję otoki OutputMessages lub nieprzetworzonego dyktu (traktowanego jako wynik wywołania narzędzia dla specyfikacji OTEL, serializowane bezpośrednio).

function recordOutputMessages(messages: ResponseMessagesParam)

Parametry

messages

ResponseMessagesParam

Ciąg, tablica ciągów, otoka OutputMessages lub dykt.

start(Request, OutputResponse, AgentDetails, UserDetails, SpanDetails)

Tworzy i uruchamia nowy zakres śledzenia komunikatów wyjściowych.

static function start(request: Request, response: OutputResponse, agentDetails: AgentDetails, userDetails?: UserDetails, spanDetails?: SpanDetails): OutputScope

Parametry

request

Request

Żądanie ładunku (kanał, identyfikator konwersacji, zawartość, identyfikator sesji).

response

OutputResponse

Odpowiedź zawierająca początkowe komunikaty wyjściowe.

agentDetails

AgentDetails

Agent generuje dane wyjściowe. Identyfikator dzierżawy pochodzi z elementu agentDetails.tenantId.

userDetails

UserDetails

Opcjonalne szczegóły tożsamości rozmówców.

spanDetails

SpanDetails

Opcjonalna konfiguracja zakresu (parentContext, startTime, endTime, spanLinks).

Zwraca

OutputScope

Nowe wystąpienie OutputScope.

Szczegóły metody dziedziczonej

dispose()

Starsza metoda usuwania pod kątem zgodności

function dispose()

Dziedziczone zopenTelemetryScope.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

Dziedziczone zopenTelemetryScope.getSpanContext

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).

Dziedziczone zatrybutów OpenTelemetryScope.recordAttributes

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".

Dziedziczone zopenTelemetryScope.recordCancellation

recordError(Error)

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

function recordError(error: Error)

Parametry

error

Error

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

Dziedziczone zopenTelemetryScope.recordError

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.

Dziedziczone zOpenTelemetryScope.setEndTime

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>

Dziedziczone zopenTelemetryScope.withActiveSpanAsync