OutputScope class

Pakke:

@microsoft/agents-a365-observability

Gir OpenTelemetry sporingsomfang for utdatameldingssporing med overordnet span-kobling.

Utvider

OpenTelemetryScope

Metoder

recordOutputMessages(ResponseMessagesParam)	Registrerer utdatameldingene for telemetrisporing. Overskriver alle tidligere innspilte utdatameldinger i tidsrommet. Godtar én enkelt streng, en matrise med strenger (automatisk innpakket som OTEL OutputMessage), en versjon av OutputMessages Wrapper eller en rå diktering (behandlet som et verktøyanropsresultat per OTEL-spesifikasjon, serialisert direkte).
start(Request, OutputResponse, AgentDetails, UserDetails, SpanDetails)	Oppretter og starter et nytt omfang for sporing av utdatameldinger.

Arvede metoder

dispose()	Eldre fjerningsmetode for kompatibilitet
getSpanContext()	Henter span-konteksten for dette omfanget. Dette kan brukes til å opprette en ParentSpanRef for eksplisitt overordnet-underordnet kobling på tvers av aynkrone grenser.
recordAttributes(undefined | null | Iterable<[string, AttributeValue]> | Record<string, AttributeValue>)	Registrerer flere attributtnøkkel-/verdipar for telemetrisporing.
recordCancellation(string)	Registrerer en avlysningshendelse i tidsrommet. Angir span-statusen til ERROR med årsaken til kanselleringen, og merker feiltypen som TaskCanceledException.
recordError(Error)	Registrerer en feil som oppstod under operasjonen
setEndTime(TimeInput)	Angir et egendefinert sluttidspunkt for omfanget. Når den er angitt, sendes denne verdien til i stedet for å span.end() bruke gjeldende veggklokketid. Dette er nyttig når det faktiske sluttidspunktet for operasjonen er kjent før omfanget fjernes.
withActiveSpanAsync<T>(() => Promise<T>)	Gjør dette tidsrommet aktivt for varigheten av den aynkrone tilbakeringingskjøringen

Metodedetaljer

recordOutputMessages(ResponseMessagesParam)

Registrerer utdatameldingene for telemetrisporing. Overskriver alle tidligere innspilte utdatameldinger i tidsrommet. Godtar én enkelt streng, en matrise med strenger (automatisk innpakket som OTEL OutputMessage), en versjon av OutputMessages Wrapper eller en rå diktering (behandlet som et verktøyanropsresultat per OTEL-spesifikasjon, serialisert direkte).

function recordOutputMessages(messages: ResponseMessagesParam)

Parametere

messages

ResponseMessagesParam

En streng, matrise med strenger, en Wrapper for OutputMessages eller en diktering.

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

Oppretter og starter et nytt omfang for sporing av utdatameldinger.

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

Parametere

request

Request

Be om nyttelast (kanal, conversationId, innhold, økt-ID).

response

OutputResponse

Svaret som inneholder innledende utdatameldinger.

agentDetails

AgentDetails

Agenten som produserer utdataene. Leier-ID er avledet fra agentDetails.tenantId.

userDetails

UserDetails

Valgfrie identitetsdetaljer for den menneskelige innringeren.

spanDetails

SpanDetails

Valgfri span-konfigurasjon (parentContext, startTime, endTime, spanLinks).

Returnerer

OutputScope

En ny OutputScope-forekomst.

Arvede metodedetaljer

dispose()

Eldre fjerningsmetode for kompatibilitet

function dispose()

Arvet fraOpenTelemetryScope.dispose

getSpanContext()

Henter span-konteksten for dette omfanget. Dette kan brukes til å opprette en ParentSpanRef for eksplisitt overordnet-underordnet kobling på tvers av aynkrone grenser.

function getSpanContext(): SpanContext

Returnerer

SpanContext

SpanContext som inneholder traceId og spanId

Arvet fraOpenTelemetryScope.getSpanContext

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

Registrerer flere attributtnøkkel-/verdipar for telemetrisporing.

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

Parametere

attributes

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

Samling av attributtnøkkel-/verdipar (matrise eller iterbar for [nøkkel, verdi] eller objektkart).

Arvet fraOpenTelemetryScope.recordAttributes

recordCancellation(string)

Registrerer en avlysningshendelse i tidsrommet. Angir span-statusen til ERROR med årsaken til kanselleringen, og merker feiltypen som TaskCanceledException.

function recordCancellation(reason?: string)

Parametere

reason

string

Valgfri annulleringsårsak. Standardinnstillingene for «Oppgaven ble avbrutt».

Arvet fraOpenTelemetryScope.recordCancellation

recordError(Error)

Registrerer en feil som oppstod under operasjonen

function recordError(error: Error)

Parametere

error

Error

Feilen som oppstod

Arvet fraOpenTelemetryScope.recordError

setEndTime(TimeInput)

Angir et egendefinert sluttidspunkt for omfanget. Når den er angitt, sendes denne verdien til i stedet for å span.end() bruke gjeldende veggklokketid. Dette er nyttig når det faktiske sluttidspunktet for operasjonen er kjent før omfanget fjernes.

function setEndTime(endTime: TimeInput)

Parametere

endTime

TimeInput

Sluttidspunktet som millisekunder siden epoke, dato eller hrtime tuppel.

Arvet fraOpenTelemetryScope.setEndTime

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

Gjør dette tidsrommet aktivt for varigheten av den aynkrone tilbakeringingskjøringen

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

Parametere

callback

() => Promise<T>

Returnerer

Promise<T>

Arvet fraOpenTelemetryScope.withActiveSpanAsync