OutputScope class

Paket:

@microsoft/agents-a365-observability

Tillhandahåller OpenTelemetry-spårningsomfång för spårning av utdatameddelanden med överordnad span-länkning.

Extends

OpenTelemetryScope

Metoder

recordOutputMessages(ResponseMessagesParam)	Registrerar utdatameddelanden för telemetrispårning. Skriver över alla tidigare inspelade utdatameddelanden i intervallet. Accepterar en enskild sträng, en matris med strängar (automatiskt omsluten som OTEL OutputMessage), en versionerad OutputMessages-omslutning eller en rå diktat (behandlas som ett verktygsanropsresultat per OTEL-specifikation, serialiserad direkt).
start(Request, OutputResponse, AgentDetails, UserDetails, SpanDetails)	Skapar och startar ett nytt omfång för spårning av utdatameddelanden.

Ärvda metoder

dispose()	Äldre bortskaffningsmetod för kompatibilitet
getSpanContext()	Hämtar span-kontexten för det här omfånget. Detta kan användas för att skapa en ParentSpanRef för explicit överordnad-underordnad länkning över asynkrona gränser.
recordAttributes(undefined | null | Iterable<[string, AttributeValue]> | Record<string, AttributeValue>)	Registrerar flera attributnyckel/värdepar för telemetrispårning.
recordCancellation(string)	Registrerar en annulleringshändelse i intervallet. Anger span-statusen till FEL med avbokningsorsaken och markerar feltypen som "TaskCanceledException".
recordError(Error)	Registrerar ett fel som inträffade under åtgärden
setEndTime(TimeInput)	Anger en anpassad sluttid för omfånget. När värdet har angetts skickas det här värdet till span.end() i stället för den aktuella tidsåtgången för väggklockan. Detta är användbart när den faktiska sluttiden för åtgärden är känd innan omfånget tas bort.
withActiveSpanAsync<T>(() => Promise<T>)	Gör det här intervallet aktivt under hela körningen av asynkron återanrop

Metodinformation

recordOutputMessages(ResponseMessagesParam)

Registrerar utdatameddelanden för telemetrispårning. Skriver över alla tidigare inspelade utdatameddelanden i intervallet. Accepterar en enskild sträng, en matris med strängar (automatiskt omsluten som OTEL OutputMessage), en versionerad OutputMessages-omslutning eller en rå diktat (behandlas som ett verktygsanropsresultat per OTEL-specifikation, serialiserad direkt).

function recordOutputMessages(messages: ResponseMessagesParam)

Parametrar

messages

ResponseMessagesParam

En sträng, matris med strängar, en OutputMessages-omslutning eller en dikta.

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

Skapar och startar ett nytt omfång för spårning av utdatameddelanden.

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

Parametrar

request

Request

Begär nyttolast (kanal, conversationId, innehåll, sessionId).

response

OutputResponse

Svaret som innehåller inledande utdatameddelanden.

agentDetails

AgentDetails

Agenten som producerar utdata. Klientorganisations-ID härleds från agentDetails.tenantId.

userDetails

UserDetails

Valfri identitetsinformation för den mänskliga uppringaren.

spanDetails

SpanDetails

Valfri span-konfiguration (parentContext, startTime, endTime, spanLinks).

Returer

OutputScope

En ny OutputScope-instans.

Ärvd metodinformation

dispose()

Äldre bortskaffningsmetod för kompatibilitet

function dispose()

Ärvd frånOpenTelemetryScope.dispose

getSpanContext()

Hämtar span-kontexten för det här omfånget. Detta kan användas för att skapa en ParentSpanRef för explicit överordnad-underordnad länkning över asynkrona gränser.

function getSpanContext(): SpanContext

Returer

SpanContext

SpanContext som innehåller traceId och spanId

Ärvd frånOpenTelemetryScope.getSpanContext

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

Registrerar flera attributnyckel/värdepar för telemetrispårning.

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

Parametrar

attributes

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

Samling attributnyckel/värdepar (matris eller itererbar för [nyckel, värde] eller objektkarta).

Ärvd frånOpenTelemetryScope.recordAttributes

recordCancellation(string)

Registrerar en annulleringshändelse i intervallet. Anger span-statusen till FEL med avbokningsorsaken och markerar feltypen som "TaskCanceledException".

function recordCancellation(reason?: string)

Parametrar

reason

string

Valfri avbokningsorsak. Standardvärdet är "Aktiviteten avbröts".

Ärvd frånOpenTelemetryScope.recordCancellation

recordError(Error)

Registrerar ett fel som inträffade under åtgärden

function recordError(error: Error)

Parametrar

error

Error

Felet som uppstod

Ärvd frånOpenTelemetryScope.recordError

setEndTime(TimeInput)

Anger en anpassad sluttid för omfånget. När värdet har angetts skickas det här värdet till span.end() i stället för den aktuella tidsåtgången för väggklockan. Detta är användbart när den faktiska sluttiden för åtgärden är känd innan omfånget tas bort.

function setEndTime(endTime: TimeInput)

Parametrar

endTime

TimeInput

Sluttiden som millisekunder sedan epoken, ett datum eller en HrTime-tupplar.

Ärvd frånOpenTelemetryScope.setEndTime

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

Gör det här intervallet aktivt under hela körningen av asynkron återanrop

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

Parametrar

callback

() => Promise<T>

Returer

Promise<T>

Ärvd frånOpenTelemetryScope.withActiveSpanAsync