OutputScope class

Πακέτο:

@microsoft/agents-a365-observability

Παρέχει εμβέλεια ανίχνευσης OpenTelemetry για ανίχνευση μηνύματος εξόδου με σύνδεση γονικού εύρους.

Επεκτείνει

OpenTelemetryScope

Μέθοδοι

recordOutputMessages(ResponseMessagesParam)	Καταγράφει τα μηνύματα εξόδου για παρακολούθηση τηλεμετρίας. Αντικαθιστά τυχόν μηνύματα εξόδου που έχουν ήδη καταγραφεί στο εύρος. Δέχεται μία μόνο συμβολοσειρά, έναν πίνακα συμβολοσειρών (αυτόματα περιτυλιγμένο ως OTEL OutputMessage), ένα περιτύλιγμα OutputMessages ή ένα ανεπεξέργαστο dict (το οποίο αντιμετωπίζεται ως αποτέλεσμα κλήσης εργαλείου ανά προδιαγραφή OTEL, σειριοποιημένο απευθείας).
start(Request, OutputResponse, AgentDetails, UserDetails, SpanDetails)	Δημιουργεί και ξεκινά μια νέα εμβέλεια για την ανίχνευση μηνύματος εξόδου.

Μέθοδοι μεταβίβασης

dispose()	Μέθοδος απόρριψης παλαιού τύπου για συμβατότητα
getSpanContext()	Λαμβάνει το περιβάλλον εύρους για αυτή την εμβέλεια. Αυτό μπορεί να χρησιμοποιηθεί για τη δημιουργία ενός ParentSpanRef για ρητή σύνδεση γονικού-θυγατρικού στοιχείου μεταξύ ασύγχρονων ορίων.
recordAttributes(undefined | null | Iterable<[string, AttributeValue]> | Record<string, AttributeValue>)	Καταγράφει πολλαπλά ζεύγη κλειδιού/τιμής χαρακτηριστικού για την παρακολούθηση τηλεμετρίας.
recordCancellation(string)	Καταγράφει ένα συμβάν ακύρωσης στο εύρος. Ορίζει την κατάσταση της περιοχής σε ERROR με την αιτία ακύρωσης και επισημαίνει τον τύπο σφάλματος ως "TaskCanceledException".
recordError(Error)	Καταγράφει ένα σφάλμα που παρουσιάστηκε κατά τη διάρκεια της λειτουργίας
setEndTime(TimeInput)	Ορίζει μια προσαρμοσμένη ώρα λήξης για την εμβέλεια. Όταν οριστεί, η επιλογή απόρριψης θα μεταβιβάσει αυτήν την τιμή στη span.end() θέση της χρήσης της τρέχουσας ώρας ρολόι τοίχου. Αυτό είναι χρήσιμο όταν η πραγματική ώρα λήξης της λειτουργίας είναι γνωστή πριν από τη διάθεση της εμβέλειας.
withActiveSpanAsync<T>(() => Promise<T>)	Αυτό το εύρος είναι ενεργό κατά τη διάρκεια της ασύγχρονης εκτέλεσης επιστροφής κλήσης

Λεπτομέρειες μεθόδου

recordOutputMessages(ResponseMessagesParam)

Καταγράφει τα μηνύματα εξόδου για παρακολούθηση τηλεμετρίας. Αντικαθιστά τυχόν μηνύματα εξόδου που έχουν ήδη καταγραφεί στο εύρος. Δέχεται μία μόνο συμβολοσειρά, έναν πίνακα συμβολοσειρών (αυτόματα περιτυλιγμένο ως OTEL OutputMessage), ένα περιτύλιγμα OutputMessages ή ένα ανεπεξέργαστο dict (το οποίο αντιμετωπίζεται ως αποτέλεσμα κλήσης εργαλείου ανά προδιαγραφή OTEL, σειριοποιημένο απευθείας).

function recordOutputMessages(messages: ResponseMessagesParam)

Παράμετροι

messages

ResponseMessagesParam

Μια συμβολοσειρά, ένας πίνακας συμβολοσειρών, ένα περιτύλιγμα OutputMessages ή ένα διάταγμα.

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

Δημιουργεί και ξεκινά μια νέα εμβέλεια για την ανίχνευση μηνύματος εξόδου.

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

Παράμετροι

request

Request

Ωφέλιμο φορτίο αίτησης (κανάλι, αναγνωριστικό συνομιλίας, περιεχόμενο, αναγνωριστικό περιόδου λειτουργίας).

response

OutputResponse

Η απόκριση που περιέχει τα αρχικά μηνύματα εξόδου.

agentDetails

AgentDetails

Ο παράγοντας που παράγει την έξοδο. Το αναγνωριστικό μισθωτή προέρχεται από agentDetails.tenantIdτο .

userDetails

UserDetails

Προαιρετικά στοιχεία ταυτότητας υπεύθυνου κλήσης.

spanDetails

SpanDetails

Προαιρετική ρύθμιση παραμέτρων εύρους (parentContext, startTime, endTime, spanLinks).

Επιστροφές

OutputScope

Μια νέα παρουσία outputScope.

Λεπτομέρειες μεθόδων μεταβίβασης

dispose()

Μέθοδος απόρριψης παλαιού τύπου για συμβατότητα

function dispose()

Κληρονομήθηκε από τοOpenTelemetryScope.dispose

getSpanContext()

Λαμβάνει το περιβάλλον εύρους για αυτή την εμβέλεια. Αυτό μπορεί να χρησιμοποιηθεί για τη δημιουργία ενός ParentSpanRef για ρητή σύνδεση γονικού-θυγατρικού στοιχείου μεταξύ ασύγχρονων ορίων.

function getSpanContext(): SpanContext

Επιστροφές

SpanContext

Το SpanContext που περιέχει traceId και spanId

Μεταβίβαση από τοOpenTelemetryScope.getSpanContext

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

Καταγράφει πολλαπλά ζεύγη κλειδιού/τιμής χαρακτηριστικού για την παρακολούθηση τηλεμετρίας.

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

Παράμετροι

attributes

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

Συλλογή ζευγών κλειδιού/τιμής χαρακτηριστικού (πίνακας ή με δυνατότητα διαδοχικών διαδοχικών τιμών [κλειδιού, τιμής] ή χάρτη αντικειμένου).

Μεταβίβαση από τοOpenTelemetryScope.recordAttributes

recordCancellation(string)

Καταγράφει ένα συμβάν ακύρωσης στο εύρος. Ορίζει την κατάσταση της περιοχής σε ERROR με την αιτία ακύρωσης και επισημαίνει τον τύπο σφάλματος ως "TaskCanceledException".

function recordCancellation(reason?: string)

Παράμετροι

reason

string

Προαιρετική αιτία ακύρωσης. Η προεπιλογή είναι "Η εργασία ακυρώθηκε".

Μεταβίβαση από τοOpenTelemetryScope.recordCancellation

recordError(Error)

Καταγράφει ένα σφάλμα που παρουσιάστηκε κατά τη διάρκεια της λειτουργίας

function recordError(error: Error)

Παράμετροι

error

Error

Το σφάλμα που παρουσιάστηκε

Μεταβίβαση από τοOpenTelemetryScope.recordError

setEndTime(TimeInput)

Ορίζει μια προσαρμοσμένη ώρα λήξης για την εμβέλεια. Όταν οριστεί, η επιλογή απόρριψης θα μεταβιβάσει αυτήν την τιμή στη span.end() θέση της χρήσης της τρέχουσας ώρας ρολόι τοίχου. Αυτό είναι χρήσιμο όταν η πραγματική ώρα λήξης της λειτουργίας είναι γνωστή πριν από τη διάθεση της εμβέλειας.

function setEndTime(endTime: TimeInput)

Παράμετροι

endTime

TimeInput

Η ώρα λήξης ως χιλιοστά του δευτερολέπτου από την χρονική σήμανση, μια ημερομηνία ή μια πλειάδα HrTime.

Μεταβίβαση από τοOpenTelemetryScope.setEndTime

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

Αυτό το εύρος είναι ενεργό κατά τη διάρκεια της ασύγχρονης εκτέλεσης επιστροφής κλήσης

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

Παράμετροι

callback

() => Promise<T>

Επιστροφές

Promise<T>

Μεταβίβαση από τοOpenTelemetryScope.withActiveSpanAsync