Builder class

חבילה:

@microsoft/agents-a365-observability

בונה לקביעת התצורה של סוכן 365 עם מעקב OpenTelemetry

שיטות

build()	בונה ולאתחל את תצורת סוכן 365
shutdown()	כיבוי OpenTelemetry SDK
start()	הפעלת OpenTelemetry SDK
withClusterCategory(ClusterCategory)	קביעת התצורה של קטגוריית האשכול עבור מייצא סוכן 365
withConfigurationProvider(IConfigurationProvider<ObservabilityConfiguration>)	קביעת התצורה של ספק התצורה עבור ObservabilityConfiguration. כאשר הוא מוגדר, ספק זה משמש את הבונה ואת הרכיבים הפנימיים שלו במקום את ספק ברירת המחדל המוקרא מתוך משתני סביבה.
withCustomLogger(ILogger)	הגדרת יישום רישום מותאם אישית עבור ערכת ה- SDK של יכולת התצפית
withExporterOptions(Partial<Agent365ExporterOptions>)	ספק קבוצה חלקית של Agent365ExporterOptions. אלה ימוזגו עם ברירות מחדל וכל clusterCategory/tokenResolver שתצורתו נקבעה באופן מפורש.
withService(string, string)	קביעת התצורה של שם השירות וגירסת מדידת השימוש
withServiceNamespace(string)	קביעת תצורה של מרחב השמות של השירות עבור מדידת שימוש (תכונת משאב service.namespace)
withTokenResolver(TokenResolver)	קביעת התצורה של פותרן האסימון עבור מייצא סוכן 365

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

build()

בונה ולאתחל את תצורת סוכן 365

function build(): boolean

החזרות

boolean

מופע NodeSDK שתצורתו נקבעה

shutdown()

כיבוי OpenTelemetry SDK

function shutdown(): Promise<void>

החזרות

Promise<void>

start()

הפעלת OpenTelemetry SDK

function start()

withClusterCategory(ClusterCategory)

קביעת התצורה של קטגוריית האשכול עבור מייצא סוכן 365

function withClusterCategory(clusterCategory: ClusterCategory): ObservabilityBuilder

פרמטרים

clusterCategory

ClusterCategory

קטגוריית האשכול (לדוגמה, "preprod", "prod")

החזרות

Builder

מופע הבונה עבור שרשרת פעולת שירות

withConfigurationProvider(IConfigurationProvider<ObservabilityConfiguration>)

קביעת התצורה של ספק התצורה עבור ObservabilityConfiguration. כאשר הוא מוגדר, ספק זה משמש את הבונה ואת הרכיבים הפנימיים שלו במקום את ספק ברירת המחדל המוקרא מתוך משתני סביבה.

function withConfigurationProvider(configProvider: IConfigurationProvider<ObservabilityConfiguration>): ObservabilityBuilder

פרמטרים

configProvider

IConfigurationProvider<ObservabilityConfiguration>

ספק התצורה

החזרות

Builder

מופע הבונה עבור שרשרת פעולת שירות

withCustomLogger(ILogger)

הגדרת יישום רישום מותאם אישית עבור ערכת ה- SDK של יכולת התצפית

function withCustomLogger(customLogger: ILogger): ObservabilityBuilder

פרמטרים

customLogger

ILogger

יישום הרישום המותאם אישית (יש ליישם ממשק ILogger)

החזרות

Builder

מופע הבונה עבור שרשרת פעולת שירות

דוגמה עם וינסטון:

const winstonLogger = winston.createLogger({...});
builder.withCustomLogger({
  info: (msg, ...args) => winstonLogger.info(msg, ...args),
  warn: (msg, ...args) => winstonLogger.warn(msg, ...args),
  error: (msg, ...args) => winstonLogger.error(msg, ...args)
});

withExporterOptions(Partial<Agent365ExporterOptions>)

ספק קבוצה חלקית של Agent365ExporterOptions. אלה ימוזגו עם ברירות מחדל וכל clusterCategory/tokenResolver שתצורתו נקבעה באופן מפורש.

function withExporterOptions(exporterOptions: Partial<Agent365ExporterOptions>): ObservabilityBuilder

פרמטרים

exporterOptions

Partial<Agent365ExporterOptions>

אפשרויות ייצוא חלקיות

החזרות

Builder

מופע הבונה עבור שרשרות

withService(string, string)

קביעת התצורה של שם השירות וגירסת מדידת השימוש

function withService(serviceName: string, serviceVersion?: string): ObservabilityBuilder

פרמטרים

serviceName

string

שם השירות

serviceVersion

string

גירסת השירות

החזרות

Builder

מופע הבונה עבור שרשרת פעולת שירות

withServiceNamespace(string)

קביעת תצורה של מרחב השמות של השירות עבור מדידת שימוש (תכונת משאב service.namespace)

function withServiceNamespace(serviceNamespace: string): ObservabilityBuilder

פרמטרים

serviceNamespace

string

מרחב השמות של השירות

החזרות

Builder

מופע הבונה עבור שרשרת פעולת שירות

withTokenResolver(TokenResolver)

קביעת התצורה של פותרן האסימון עבור מייצא סוכן 365

function withTokenResolver(tokenResolver: TokenResolver): ObservabilityBuilder

פרמטרים

tokenResolver

TokenResolver

פונקציה לפתרון אסימוני אימות

החזרות

Builder

מופע הבונה עבור שרשרת פעולת שירות