OutputScope class

Balíček:

@microsoft/agents-a365-observability

Poskytuje rozsah trasování OpenTelemetry pro trasování výstupních zpráv s propojením nadřazeného rozsahu.

Extends

OpenTelemetryScope

Metody

recordOutputMessages(ResponseMessagesParam)	Zaznamenává výstupní zprávy pro sledování telemetrie. Přepíše všechny dříve zaznamenané výstupní zprávy v rozsahu. Přijímá jeden řetězec, pole řetězců (automaticky zabalené jako OTEL OutputMessage), obálku OutputMessage verze nebo nezpracovaný dikt (považováno za výsledek volání nástroje podle specifikace OTEL, serializované přímo).
start(Request, OutputResponse, AgentDetails, UserDetails, SpanDetails)	Vytvoří a spustí nový obor pro trasování výstupních zpráv.

Zděděné metody

dispose()	Starší metoda Dispose pro zajištění kompatibility
getSpanContext()	Získá kontext rozsahu pro tento obor. To lze použít k vytvoření ParentSpanRef pro explicitní propojení nadřazené-podřízené přes async hranice.
recordAttributes(undefined | null | Iterable<[string, AttributeValue]> | Record<string, AttributeValue>)	Zaznamenává několik párů klíč/hodnota atributu pro sledování telemetrie.
recordCancellation(string)	Zaznamenává událost zrušení v rozsahu. Nastaví stav rozsahu na ERROR s důvodem zrušení a označí typ chyby jako TaskCanceledException.
recordError(Error)	Zaznamenává chybu, ke které došlo během operace.
setEndTime(TimeInput)	Nastaví vlastní koncový čas oboru. Při nastavení funkce Dispose tuto hodnotu span.end() předá místo použití aktuálního času na zdi. To je užitečné, když je skutečný čas ukončení operace známý před odstraněním oboru.
withActiveSpanAsync<T>(() => Promise<T>)	Nastaví toto rozsah aktivní po dobu provádění asynchronního zpětného volání.

Podrobnosti metody

recordOutputMessages(ResponseMessagesParam)

Zaznamenává výstupní zprávy pro sledování telemetrie. Přepíše všechny dříve zaznamenané výstupní zprávy v rozsahu. Přijímá jeden řetězec, pole řetězců (automaticky zabalené jako OTEL OutputMessage), obálku OutputMessage verze nebo nezpracovaný dikt (považováno za výsledek volání nástroje podle specifikace OTEL, serializované přímo).

function recordOutputMessages(messages: ResponseMessagesParam)

Parametry

messages

ResponseMessagesParam

Řetězec, pole řetězců, obálka OutputMessages nebo diktování.

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

Vytvoří a spustí nový obor pro trasování výstupních zpráv.

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

Parametry

request

Request

Žádost o datovou část (kanál, id konverzace, obsah, id relace).

response

OutputResponse

Odpověď obsahující počáteční výstupní zprávy.

agentDetails

AgentDetails

Agent vytváří výstup. ID tenanta je odvozeno od agentDetails.tenantId.

userDetails

UserDetails

Volitelné podrobnosti o identitě volajícího člověka

spanDetails

SpanDetails

Volitelná konfigurace rozsahu (parentContext, startTime, endTime, spanLinks).

Návraty

OutputScope

Nová instance OutputScope.

Podrobnosti zděděných metod

dispose()

Starší metoda Dispose pro zajištění kompatibility

function dispose()

Zděděno zOpenTelemetryScope.dispose

getSpanContext()

Získá kontext rozsahu pro tento obor. To lze použít k vytvoření ParentSpanRef pro explicitní propojení nadřazené-podřízené přes async hranice.

function getSpanContext(): SpanContext

Návraty

SpanContext

SpanContext obsahující traceId a spanId

Zděděno zOpenTelemetryScope.getSpanContext

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

Zaznamenává několik párů klíč/hodnota atributu pro sledování telemetrie.

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

Parametry

attributes

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

Kolekce párů klíč/hodnota atributu (pole nebo iterable z [klíč, hodnota] nebo mapování objektů).

Zděděno zOpenTelemetryScope.recordAttributes

recordCancellation(string)

Zaznamenává událost zrušení v rozsahu. Nastaví stav rozsahu na ERROR s důvodem zrušení a označí typ chyby jako TaskCanceledException.

function recordCancellation(reason?: string)

Parametry

reason

string

Volitelný důvod zrušení Výchozí hodnota je "Úkol byl zrušen".

Zděděno zOpenTelemetryScope.recordCancellation

recordError(Error)

Zaznamenává chybu, ke které došlo během operace.

function recordError(error: Error)

Parametry

error

Error

Chyba, která nastala

Zděděno zOpenTelemetryScope.recordError

setEndTime(TimeInput)

Nastaví vlastní koncový čas oboru. Při nastavení funkce Dispose tuto hodnotu span.end() předá místo použití aktuálního času na zdi. To je užitečné, když je skutečný čas ukončení operace známý před odstraněním oboru.

function setEndTime(endTime: TimeInput)

Parametry

endTime

TimeInput

Koncový čas jako milisekundy od epochy, data nebo řazené kolekce členů HrTime.

Zděděno zOpenTelemetryScope.setEndTime

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

Nastaví toto rozsah aktivní po dobu provádění asynchronního zpětného volání.

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

Parametry

callback

() => Promise<T>

Návraty

Promise<T>

Zděděno zOpenTelemetryScope.withActiveSpanAsync