OutputScope class

Pakket:

@microsoft/agents-a365-observability

Biedt openTelemetry-traceringsbereik voor tracering van uitvoerberichten met bovenliggende spankoppeling.

Uitbreiding

OpenTelemetryScope

Methoden

recordOutputMessages(ResponseMessagesParam)

Registreert de uitvoerberichten voor telemetrietracering. Hiermee overschrijft u eventuele eerder opgenomen uitvoerberichten over het bereik. Accepteert één tekenreeks, een matrix met tekenreeksen (automatisch verpakt als OTEL OutputMessage), een geversiede OutputMessages-wrapper of een onbewerkte dict (behandeld als een resultaat van de toolaanroep per OTEL-specificatie, rechtstreeks geserialiseerd).

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

Hiermee maakt en start u een nieuw bereik voor tracering van uitvoerberichten.

Overgenomen methoden

dispose()	Verouderde verwijderingsmethode voor compatibiliteit
getSpanContext()	Hiermee haalt u de spancontext voor dit bereik op. Dit kan worden gebruikt om een ParentSpanRef te maken voor expliciete bovenliggende en onderliggende koppelingen tussen asynchrone grenzen.
recordAttributes(undefined | null | Iterable<[string, AttributeValue]> | Record<string, AttributeValue>)	Registreert meerdere kenmerksleutel-/waardeparen voor telemetrietracering.
recordCancellation(string)	Registreert een annuleringsevenement voor de periode. Hiermee stelt u de spanstatus in op ERROR met de reden van de annulering en wordt het fouttype gemarkeerd als 'TaskCanceledException'.
recordError(Error)	Registreert een fout die is opgetreden tijdens de bewerking
setEndTime(TimeInput)	Hiermee stelt u een aangepaste eindtijd in voor het bereik. Wanneer dit is ingesteld, wordt deze waarde doorgegeven aan span.end() in plaats van de huidige tijd van de wandklok te gebruiken. Dit is handig wanneer de werkelijke eindtijd van de bewerking bekend is voordat het bereik wordt verwijderd.
withActiveSpanAsync<T>(() => Promise<T>)	Hiermee wordt deze periode actief voor de duur van de uitvoering van de asynchrone callback

Methodedetails

recordOutputMessages(ResponseMessagesParam)

Registreert de uitvoerberichten voor telemetrietracering. Hiermee overschrijft u eventuele eerder opgenomen uitvoerberichten over het bereik. Accepteert één tekenreeks, een matrix met tekenreeksen (automatisch verpakt als OTEL OutputMessage), een geversiede OutputMessages-wrapper of een onbewerkte dict (behandeld als een resultaat van de toolaanroep per OTEL-specificatie, rechtstreeks geserialiseerd).

function recordOutputMessages(messages: ResponseMessagesParam)

Parameters

messages

ResponseMessagesParam

Een tekenreeks, matrix met tekenreeksen, een OutputMessages-wrapper of een dict.

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

Hiermee maakt en start u een nieuw bereik voor tracering van uitvoerberichten.

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

Parameters

request

Request

Nettolading aanvragen (kanaal, conversationId, inhoud, sessionId).

response

OutputResponse

Het antwoord met initiële uitvoerberichten.

agentDetails

AgentDetails

De agent die de uitvoer produceert. Tenant-id is afgeleid van agentDetails.tenantId.

userDetails

UserDetails

Optionele identiteitsgegevens van de beller.

spanDetails

SpanDetails

Optionele spanconfiguratie (parentContext, startTime, endTime, spanLinks).

Retouren

OutputScope

Een nieuw OutputScope-exemplaar.

Details overgenomen methode

dispose()

Verouderde verwijderingsmethode voor compatibiliteit

function dispose()

Overgenomen vanOpenTelemetryScope.dispose

getSpanContext()

Hiermee haalt u de spancontext voor dit bereik op. Dit kan worden gebruikt om een ParentSpanRef te maken voor expliciete bovenliggende en onderliggende koppelingen tussen asynchrone grenzen.

function getSpanContext(): SpanContext

Retouren

SpanContext

De SpanContext met traceId en spanId

Overgenomen vanOpenTelemetryScope.getSpanContext

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

Registreert meerdere kenmerksleutel-/waardeparen voor telemetrietracering.

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

Parameters

attributes

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

Verzameling kenmerksleutel-/waardeparen (matrix of itereerbaar van [sleutel, waarde] of objecttoewijzing).

Overgenomen vanOpenTelemetryScope.recordAttributes

recordCancellation(string)

Registreert een annuleringsevenement voor de periode. Hiermee stelt u de spanstatus in op ERROR met de reden van de annulering en wordt het fouttype gemarkeerd als 'TaskCanceledException'.

function recordCancellation(reason?: string)

Parameters

reason

string

Optionele annuleringsreden. De standaardwaarde is 'Taak is geannuleerd'.

Overgenomen vanOpenTelemetryScope.recordCancellation

recordError(Error)

Registreert een fout die is opgetreden tijdens de bewerking

function recordError(error: Error)

Parameters

error

Error

De fout die is opgetreden

Overgenomen vanOpenTelemetryScope.recordError

setEndTime(TimeInput)

Hiermee stelt u een aangepaste eindtijd in voor het bereik. Wanneer dit is ingesteld, wordt deze waarde doorgegeven aan span.end() in plaats van de huidige tijd van de wandklok te gebruiken. Dit is handig wanneer de werkelijke eindtijd van de bewerking bekend is voordat het bereik wordt verwijderd.

function setEndTime(endTime: TimeInput)

Parameters

endTime

TimeInput

De eindtijd als milliseconden sinds epoch, een datum of een HrTime-tuple.

Overgenomen vanOpenTelemetryScope.setEndTime

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

Hiermee wordt deze periode actief voor de duur van de uitvoering van de asynchrone callback

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

Parameters

callback

() => Promise<T>

Retouren

Promise<T>

Overgenomen vanOpenTelemetryScope.withActiveSpanAsync