OutputScope class

חבילה:

@microsoft/agents-a365-observability

מתן טווח מעקב של OpenTelemetry עבור מעקב אחר הודעת פלט עם קישור טווח אב.

מרחיב

OpenTelemetryScope

שיטות

recordOutputMessages(ResponseMessagesParam)	מתעד את הודעות הפלט למעקב אחר מדידת שימוש. מחליף את כל הודעות הפלט שהוקלטו בעבר על-פני כל טווח. מקבל מחרוזת בודדת, מערך של מחרוזות (עם גלישה אוטומטית כ- OTEL OutputMessage), עטיפת OutputMessages מגירסה או הכתבה גולמית (מטופלת כתוצאת קריאה לכל מפרט OTEL, העריכה בסידרה ישירה).
start(Request, OutputResponse, AgentDetails, UserDetails, SpanDetails)	יצירה ומתחילה של טווח חדש עבור מעקב אחר הודעת פלט.

שיטות שעברו בירושה

dispose()	שיטת מחיקה מדור קודם לצורך תאימות
getSpanContext()	מקבל את הקשר הטווח עבור טווח זה. ניתן להשתמש באפשרות זו כדי ליצור ParentSpanRef עבור קישור אב-צאצא מפורש בין גבולות אסינכרונים.
recordAttributes(undefined | null | Iterable<[string, AttributeValue]> | Record<string, AttributeValue>)	מתעד זוגות מפתח/ערך של תכונות מרובות עבור מעקב אחר מדידת שימוש.
recordCancellation(string)	מתעד אירוע ביטול על לאורך. הגדרת מצב טווח לשגיאה עם סיבת הביטול וסמנת את סוג השגיאה כ- 'TaskCanceledException'.
recordError(Error)	מתעד שגיאה שאירעה במהלך הפעולה
setEndTime(TimeInput)	הגדרת שעת סיום מותאמת אישית עבור הטווח. כאשר אפשרות זו מוגדרת, הפונקציה תגיש ערך span.end() זה במקום להשתמש בזמן שעון הקיר הנוכחי. פעולה זו שימושית כאשר שעת הסיום בפועל של הפעולה ידועה לפני הסרת הטווח.
withActiveSpanAsync<T>(() => Promise<T>)	הפיכת טווח זה לפעיל למשך הזמן של ביצוע ההתקשרות חזרה האסינכרונית

פרטי פעולת השירות

recordOutputMessages(ResponseMessagesParam)

מתעד את הודעות הפלט למעקב אחר מדידת שימוש. מחליף את כל הודעות הפלט שהוקלטו בעבר על-פני כל טווח. מקבל מחרוזת בודדת, מערך של מחרוזות (עם גלישה אוטומטית כ- OTEL OutputMessage), עטיפת OutputMessages מגירסה או הכתבה גולמית (מטופלת כתוצאת קריאה לכל מפרט 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

בקש תוכן מנה (ערוץ, conversationId, תוכן, sessionId).

response

OutputResponse

התגובה המכילה הודעות פלט התחלתיות.

agentDetails

AgentDetails

הסוכן המייצר את הפלט. מזהה הדייר נגזר מ- agentDetails.tenantId.

userDetails

UserDetails

פרטי זיהוי מתקשר אנושי אופציונליים.

spanDetails

SpanDetails

תצורת span אופציונלית (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)

מתעד אירוע ביטול על לאורך. הגדרת מצב טווח לשגיאה עם סיבת הביטול וסמנת את סוג השגיאה כ- '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

שעת הסיום כמילפיות שניה מאז epoch, Date או קבוצת משתנים של HrTime.

עובר בירושה מ- OpenTelemetryScope.setEndTime

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

הפיכת טווח זה לפעיל למשך הזמן של ביצוע ההתקשרות חזרה האסינכרונית

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

פרמטרים

callback

() => Promise<T>

החזרות

Promise<T>

עובר בירושה מ- OpenTelemetryScope.withActiveSpanAsync