Builder class

Πακέτο:

@microsoft/agents-a365-observability

Builder για τη ρύθμιση παραμέτρων του Παράγοντα 365 με ανίχνευση OpenTelemetry

Μέθοδοι

build()	Δημιουργεί και προετοιμάζει τη ρύθμιση παραμέτρων του Παράγοντα 365
shutdown()	Κλείνει το OpenTelemetry SDK
start()	Εκκίνηση του OpenTelemetry SDK
withClusterCategory(ClusterCategory)	Ρυθμίζει την κατηγορία συμπλέγματος για τον εξαγωγέα Agent 365
withConfigurationProvider(IConfigurationProvider<ObservabilityConfiguration>)	Ρυθμίζει τις παραμέτρους της υπηρεσίας παροχής ρύθμισης παραμέτρων για ObservabilityConfiguration. Όταν οριστεί, αυτή η υπηρεσία παροχής χρησιμοποιείται από το εργαλείο δόμησης και τα εσωτερικά στοιχεία της αντί για την προεπιλεγμένη υπηρεσία παροχής που διαβάζει από μεταβλητές περιβάλλοντος.
withCustomLogger(ILogger)	Ορίζει μια προσαρμοσμένη υλοποίηση καταγραφής για το SDK παρατηρησιμότητας
withExporterOptions(Partial<Agent365ExporterOptions>)	Καταχωρήστε ένα μερικό σύνολο Agent365ExporterOptions. Αυτές θα συγχωνευτούν με τις προεπιλογές και τυχόν ρητά ρυθμισμένο σύμπλεγμαCategory/tokenResolver.
withService(string, string)	Ρυθμίζει το όνομα και την έκδοση υπηρεσίας για την τηλεμετρία
withServiceNamespace(string)	Ρυθμίζει τον χώρο ονομάτων υπηρεσίας για την τηλεμετρία (χαρακτηριστικό πόρου service.namespace)
withTokenResolver(TokenResolver)	Ρυθμίζει τις παραμέτρους για την επίλυση διακριτικού για τον εξαγωγέα Agent 365

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

build()

Δημιουργεί και προετοιμάζει τη ρύθμιση παραμέτρων του Παράγοντα 365

function build(): boolean

Επιστροφές

boolean

Η ρυθμισμένη παρουσία NodeSDK

shutdown()

Κλείνει το OpenTelemetry SDK

function shutdown(): Promise<void>

Επιστροφές

Promise<void>

start()

Εκκίνηση του OpenTelemetry SDK

function start()

withClusterCategory(ClusterCategory)

Ρυθμίζει την κατηγορία συμπλέγματος για τον εξαγωγέα Agent 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

Η παρουσία του εργαλείου δόμησης για τη σύνδεση σε αλυσίδα μεθόδων

Παράδειγμα με τον Winston:

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. Αυτές θα συγχωνευτούν με τις προεπιλογές και τυχόν ρητά ρυθμισμένο σύμπλεγμαCategory/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)

Ρυθμίζει τις παραμέτρους για την επίλυση διακριτικού για τον εξαγωγέα Agent 365

function withTokenResolver(tokenResolver: TokenResolver): ObservabilityBuilder

Παράμετροι

tokenResolver

TokenResolver

Συνάρτηση για την επίλυση διακριτικών ελέγχου ταυτότητας

Επιστροφές

Builder

Η παρουσία του εργαλείου δόμησης για τη σύνδεση σε αλυσίδα μεθόδων