OutputScope class
Stellt den Bereich der OpenTelemetry-Ablaufverfolgung für die Ausgabenachrichtenablaufverfolgung mit übergeordneter Spanverknüpfung bereit.
- Extends
Methoden
| record |
Zeichnet die Ausgabemeldungen für die Telemetrienachverfolgung auf. Überschreibt alle zuvor aufgezeichneten Ausgabemeldungen in der Spanne. Akzeptiert eine einzelne Zeichenfolge, ein Array von Zeichenfolgen (automatisch umbrochen als OTEL OutputMessage), einen versionsgesteuerten OutputMessages-Wrapper oder ein unformatiertes Diktat (behandelt als Toolaufrufergebnis pro OTEL-Spezifikation, serialisiert direkt). |
| start(Request, Output |
Erstellt und startet einen neuen Bereich für die Ausgabenachrichtenablaufverfolgung. |
Geerbte Methoden
| dispose() | Legacy-Dispose-Methode zur Kompatibilität |
| get |
Ruft den Span-Kontext für diesen Bereich ab. Dies kann verwendet werden, um eine ParentSpanRef für explizite verknüpfung zwischen übergeordneten und untergeordneten Elementen über asynchrone Grenzen hinweg zu erstellen. |
| record |
Zeichnet mehrere Attributschlüssel-Wert-Paare für die Telemetrienachverfolgung auf. |
| record |
Zeichnet ein Abbruchereignis auf der Spanne auf. Legt den Span-Status auf ERROR mit dem Abbruchgrund fest und markiert den Fehlertyp als "TaskCanceledException". |
| record |
Zeichnet einen Fehler auf, der während des Vorgangs aufgetreten ist. |
| set |
Legt eine benutzerdefinierte Endzeit für den Bereich fest.
Wenn dieser Wert festgelegt ist, übergibt Dispose diesen Wert |
| with |
Macht diese Spanne für die Dauer der asynchronen Rückrufausführung aktiv |
Details zur Methode
recordOutputMessages(ResponseMessagesParam)
Zeichnet die Ausgabemeldungen für die Telemetrienachverfolgung auf. Überschreibt alle zuvor aufgezeichneten Ausgabemeldungen in der Spanne. Akzeptiert eine einzelne Zeichenfolge, ein Array von Zeichenfolgen (automatisch umbrochen als OTEL OutputMessage), einen versionsgesteuerten OutputMessages-Wrapper oder ein unformatiertes Diktat (behandelt als Toolaufrufergebnis pro OTEL-Spezifikation, serialisiert direkt).
function recordOutputMessages(messages: ResponseMessagesParam)Parameter
- messages
- ResponseMessagesParam
Eine Zeichenfolge, ein Array von Zeichenfolgen, ein OutputMessages-Wrapper oder ein Diktat.
start(Request, OutputResponse, AgentDetails, UserDetails, SpanDetails)
Erstellt und startet einen neuen Bereich für die Ausgabenachrichtenablaufverfolgung.
static function start(request: Request, response: OutputResponse, agentDetails: AgentDetails, userDetails?: UserDetails, spanDetails?: SpanDetails): OutputScopeParameter
- request
- Request
Anforderungsnutzlast (Kanal, conversationId, Inhalt, sessionId).
- response
- OutputResponse
Die Antwort, die anfängliche Ausgabemeldungen enthält.
- agentDetails
- AgentDetails
Der Agent, der die Ausgabe erzeugt. Die Mandanten-ID wird von agentDetails.tenantId.
- userDetails
- UserDetails
Optionale Identitätsdetails für den Anrufer.
- spanDetails
- SpanDetails
Optionale Span-Konfiguration (parentContext, startTime, endTime, spanLinks).
Gibt zurück
Eine neue OutputScope-Instanz.
Details zur geerbten Methode
dispose()
getSpanContext()
Ruft den Span-Kontext für diesen Bereich ab. Dies kann verwendet werden, um eine ParentSpanRef für explizite verknüpfung zwischen übergeordneten und untergeordneten Elementen über asynchrone Grenzen hinweg zu erstellen.
function getSpanContext(): SpanContextGibt zurück
SpanContext
Der SpanContext mit traceId und spanId
Geerbt vonOpenTelemetryScope.getSpanContext
recordAttributes(undefined | null | Iterable<[string, AttributeValue]> | Record<string, AttributeValue>)
Zeichnet mehrere Attributschlüssel-Wert-Paare für die Telemetrienachverfolgung auf.
function recordAttributes(attributes: undefined | null | Iterable<[string, AttributeValue]> | Record<string, AttributeValue>)Parameter
- attributes
-
undefined | null | Iterable<[string, AttributeValue]> | Record<string, AttributeValue>
Auflistung von Attributschlüssel-Wert-Paaren (Array oder iterierbar von [Schlüssel, Wert] oder Objektzuordnung).
Geerbt vonOpenTelemetryScope.recordAttributes
recordCancellation(string)
Zeichnet ein Abbruchereignis auf der Spanne auf. Legt den Span-Status auf ERROR mit dem Abbruchgrund fest und markiert den Fehlertyp als "TaskCanceledException".
function recordCancellation(reason?: string)Parameter
- reason
-
string
Optionaler Abbruchgrund. Der Standardwert ist "Vorgang wurde abgebrochen".
Geerbt vonOpenTelemetryScope.recordCancellation
recordError(Error)
Zeichnet einen Fehler auf, der während des Vorgangs aufgetreten ist.
function recordError(error: Error)Parameter
- error
-
Error
Der Fehler, der aufgetreten ist
Geerbt vonOpenTelemetryScope.recordError
setEndTime(TimeInput)
Legt eine benutzerdefinierte Endzeit für den Bereich fest.
Wenn dieser Wert festgelegt ist, übergibt Dispose diesen Wert span.end() anstelle der aktuellen Zeit für die Wanduhr.
Dies ist nützlich, wenn die tatsächliche Endzeit des Vorgangs bekannt ist, bevor der Bereich verworfen wird.
function setEndTime(endTime: TimeInput)Parameter
- endTime
-
TimeInput
Die Endzeit als Millisekunden seit Epoche, Datum oder HrTime-Tupel.
Geerbt vonOpenTelemetryScope.setEndTime
withActiveSpanAsync<T>(() => Promise<T>)
Macht diese Spanne für die Dauer der asynchronen Rückrufausführung aktiv
function withActiveSpanAsync<T>(callback: () => Promise<T>): Promise<T>Parameter
- callback
-
() => Promise<T>
Gibt zurück
Promise<T>
Geerbt vonOpenTelemetryScope.withActiveSpanAsync