OutputScope class

Pakke:
@microsoft/agents-a365-observability

Leverer sporingsområdet for OpenTelemetry for sporing af outputmeddelelser med overordnet span linking.

Udvider
OpenTelemetryScope

Metoder

recordOutputMessages(ResponseMessagesParam)

Registrerer outputmeddelelserne til telemetrisporing. Overskriver alle tidligere optagede outputmeddelelser på området. Accepterer en enkelt streng, en matrix af strenge (automatisk ombrudt som OTEL OutputMessage), en versioned OutputMessages-ombrydning eller et råt dikt (behandles som et værktøjskaldsresultat pr. OTEL-specifikation, serialiseret direkte).
start(Request, OutputResponse, AgentDetails, UserDetails, SpanDetails)

Opretter og starter et nyt område for sporing af outputmeddelelser.

Nedarvede metoder

dispose()

Ældre metode til fjernelse af kompatibilitet
getSpanContext()

Henter omfangets kontekst for dette område. Dette kan bruges til at oprette en ParentSpanRef til eksplicit overordnet/underordnet-sammenkædning på tværs af asynkrone grænser.
recordAttributes(undefined | null | Iterable<[string, AttributeValue]> | Record<string, AttributeValue>)

Registrerer flere attributnøgle-/værdipar til telemetrisporing.
recordCancellation(string)

Registrerer en annulleringshændelse på området. Angiver status for span til ERROR med annulleringsårsagen og markerer fejltypen som 'TaskCanceledException'.
recordError(Error)

Registrerer en fejl, der opstod under handlingen
setEndTime(TimeInput)

Angiver et brugerdefineret sluttidspunkt for området. Når den er indstillet, overføres denne værdi til i stedet for at span.end() bruge det aktuelle vægklokkeslæt. Dette er nyttigt, når det faktiske sluttidspunkt for handlingen er kendt, før området fjernes.
withActiveSpanAsync<T>(() => Promise<T>)

Gør dette tidsrum aktivt i varigheden af den asynkrone tilbagekaldskørsel

Oplysninger om metode

recordOutputMessages(ResponseMessagesParam)

Registrerer outputmeddelelserne til telemetrisporing. Overskriver alle tidligere optagede outputmeddelelser på området. Accepterer en enkelt streng, en matrix af strenge (automatisk ombrudt som OTEL OutputMessage), en versioned OutputMessages-ombrydning eller et råt dikt (behandles som et værktøjskaldsresultat pr. OTEL-specifikation, serialiseret direkte).

function recordOutputMessages(messages: ResponseMessagesParam)

Parametre

messages
ResponseMessagesParam

En streng, matrix af strenge, en OutputMessages-ombrydning eller et dikt.

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

Opretter og starter et nyt område for sporing af outputmeddelelser.

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

Parametre

request
Request

Anmod om nyttedata (kanal, samtale-id, indhold, sessionId).

response
OutputResponse

Svaret, der indeholder de indledende outputmeddelelser.

agentDetails
AgentDetails

Den agent, der producerer outputtet. Lejer-id'et er afledt af agentDetails.tenantId.

userDetails
UserDetails

Valgfri oplysninger om personidentitet.

spanDetails
SpanDetails

Valgfri konfiguration af rækkevidde (parentContext, startTime, endTime, spanLinks).

Returnerer

OutputScope

En ny OutputScope-forekomst.

Oplysninger om nedarvede metoder

dispose()

Ældre metode til fjernelse af kompatibilitet

function dispose()

Nedarvet fraOpenTelemetryScope.dispose

getSpanContext()

Henter omfangets kontekst for dette område. Dette kan bruges til at oprette en ParentSpanRef til eksplicit overordnet/underordnet-sammenkædning på tværs af asynkrone grænser.

function getSpanContext(): SpanContext

Returnerer

SpanContext

SpanContext, der indeholder traceId og spanId

Nedarvet fraOpenTelemetryScope.getSpanContext

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

Registrerer flere attributnøgle-/værdipar til telemetrisporing.

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

Parametre

attributes

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

Samling af attributnøgle-/værdipar (matrix eller iterbar af [nøgle, værdi] eller objekttilknytning).

Nedarvet fraOpenTelemetryScope.recordAttributes

recordCancellation(string)

Registrerer en annulleringshændelse på området. Angiver status for span til ERROR med annulleringsårsagen og markerer fejltypen som 'TaskCanceledException'.

function recordCancellation(reason?: string)

Parametre

reason

string

Valgfri årsag til annullering. Som standard er "Opgaven blev annulleret".

Nedarvet fraOpenTelemetryScope.recordCancellation

recordError(Error)

Registrerer en fejl, der opstod under handlingen

function recordError(error: Error)

Parametre

error

Error

Den fejl, der opstod

Nedarvet fraOpenTelemetryScope.recordError

setEndTime(TimeInput)

Angiver et brugerdefineret sluttidspunkt for området. Når den er indstillet, overføres denne værdi til i stedet for at span.end() bruge det aktuelle vægklokkeslæt. Dette er nyttigt, når det faktiske sluttidspunkt for handlingen er kendt, før området fjernes.

function setEndTime(endTime: TimeInput)

Parametre

endTime

TimeInput

Sluttidspunktet som millisekunder siden epoken, en dato eller en TTime-tupel.

Nedarvet fraOpenTelemetryScope.setEndTime

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

Gør dette tidsrum aktivt i varigheden af den asynkrone tilbagekaldskørsel

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

Parametre

callback

() => Promise<T>

Returnerer

Promise<T>

Nedarvet fraOpenTelemetryScope.withActiveSpanAsync