OpenTelemetryScope class

חבילה:

@microsoft/agents-a365-observability

מחלקת בסיס עבור טווחי מעקב של OpenTelemetry

שיטות

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>)	הפיכת טווח זה לפעיל למשך הזמן של ביצוע ההתקשרות חזרה האסינכרונית

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

dispose()

שיטת מחיקה מדור קודם לצורך תאימות

function dispose()

getSpanContext()

מקבל את הקשר הטווח עבור טווח זה. ניתן להשתמש באפשרות זו כדי ליצור ParentSpanRef עבור קישור אב-צאצא מפורש בין גבולות אסינכרונים.

function getSpanContext(): SpanContext

החזרות

SpanContext

ה- SpanContext המכיל traceId ו- spanId

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>

אוסף של זוגות מפתח/ערך של תכונה (מערך או לא ניתן להפעלה של [מפתח, ערך] או מפת אובייקטים).

recordCancellation(string)

מתעד אירוע ביטול על לאורך. הגדרת מצב טווח לשגיאה עם סיבת הביטול וסמנת את סוג השגיאה כ- 'TaskCanceledException'.

function recordCancellation(reason?: string)

פרמטרים

reason

string

סיבת ביטול אופציונלית. ברירות מחדל עבור 'המשימה בוטלה'.

recordError(Error)

מתעד שגיאה שאירעה במהלך הפעולה

function recordError(error: Error)

פרמטרים

error

Error

השגיאה שאירעה

setEndTime(TimeInput)

הגדרת שעת סיום מותאמת אישית עבור הטווח. כאשר אפשרות זו מוגדרת, הפונקציה תגיש ערך span.end() זה במקום להשתמש בזמן שעון הקיר הנוכחי. פעולה זו שימושית כאשר שעת הסיום בפועל של הפעולה ידועה לפני הסרת הטווח.

function setEndTime(endTime: TimeInput)

פרמטרים

endTime

TimeInput

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

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

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

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

פרמטרים

callback

() => Promise<T>

החזרות

Promise<T>