Freigeben über


Builder class

Generator zum Konfigurieren von Agent 365 mit OpenTelemetry-Ablaufverfolgung

Methoden

build()

Erstellt und initialisiert die Agent 365-Konfiguration

shutdown()

Herunterfahren des OpenTelemetry SDK

start()

Startet das OpenTelemetry SDK

withClusterCategory(ClusterCategory)

Konfiguriert die Clusterkategorie für agent 365-Exporter

withConfigurationProvider(IConfigurationProvider<ObservabilityConfiguration>)

Konfiguriert den Konfigurationsanbieter für ObservabilityConfiguration. Bei Festlegung wird dieser Anbieter vom Generator und seinen internen Komponenten anstelle des Standardanbieters verwendet, der aus Umgebungsvariablen liest.

withCustomLogger(ILogger)

Legt eine benutzerdefinierte Loggerimplementierung für das Observability SDK fest

withExporterOptions(Partial<Agent365ExporterOptions>)

Stellen Sie einen Teilsatz von Agent365ExporterOptions bereit. Diese werden mit Standardeinstellungen und allen explizit konfigurierten clusterCategory/tokenResolver zusammengeführt.

withService(string, string)

Konfiguriert den Dienstnamen und die Version für Telemetrie.

withServiceNamespace(string)

Konfiguriert den Dienstnamespace für Telemetrie (Service.namespace-Ressourcenattribut)

withTokenResolver(TokenResolver)

Konfiguriert den Tokenlöser für den Agent 365-Exporter.

Details zur Methode

build()

Erstellt und initialisiert die Agent 365-Konfiguration

function build(): boolean

Gibt zurück

boolean

Die konfigurierte NodeSDK-Instanz

shutdown()

Herunterfahren des OpenTelemetry SDK

function shutdown(): Promise<void>

Gibt zurück

Promise<void>

start()

Startet das OpenTelemetry SDK

function start()

withClusterCategory(ClusterCategory)

Konfiguriert die Clusterkategorie für agent 365-Exporter

function withClusterCategory(clusterCategory: ClusterCategory): ObservabilityBuilder

Parameter

clusterCategory
ClusterCategory

Die Clusterkategorie (z. B. "Preprod", "prod")

Gibt zurück

Die Generatorinstanz für die Methodenkette

withConfigurationProvider(IConfigurationProvider<ObservabilityConfiguration>)

Konfiguriert den Konfigurationsanbieter für ObservabilityConfiguration. Bei Festlegung wird dieser Anbieter vom Generator und seinen internen Komponenten anstelle des Standardanbieters verwendet, der aus Umgebungsvariablen liest.

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

Parameter

configProvider

IConfigurationProvider<ObservabilityConfiguration>

Der Konfigurationsanbieter

Gibt zurück

Die Generatorinstanz für die Methodenkette

withCustomLogger(ILogger)

Legt eine benutzerdefinierte Loggerimplementierung für das Observability SDK fest

function withCustomLogger(customLogger: ILogger): ObservabilityBuilder

Parameter

customLogger
ILogger

Die implementierung des benutzerdefinierten Loggers (muss ILogger-Schnittstelle implementieren)

Gibt zurück

Die Generatorinstanz für die Methodenkette

Beispiel mit 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>)

Stellen Sie einen Teilsatz von Agent365ExporterOptions bereit. Diese werden mit Standardeinstellungen und allen explizit konfigurierten clusterCategory/tokenResolver zusammengeführt.

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

Parameter

exporterOptions

Partial<Agent365ExporterOptions>

Teilexportieroptionen

Gibt zurück

Die Generatorinstanz für Verkettung

withService(string, string)

Konfiguriert den Dienstnamen und die Version für Telemetrie.

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

Parameter

serviceName

string

Der Dienstname

serviceVersion

string

Die Dienstversion

Gibt zurück

Die Generatorinstanz für die Methodenkette

withServiceNamespace(string)

Konfiguriert den Dienstnamespace für Telemetrie (Service.namespace-Ressourcenattribut)

function withServiceNamespace(serviceNamespace: string): ObservabilityBuilder

Parameter

serviceNamespace

string

Der Dienstnamespace

Gibt zurück

Die Generatorinstanz für die Methodenkette

withTokenResolver(TokenResolver)

Konfiguriert den Tokenlöser für den Agent 365-Exporter.

function withTokenResolver(tokenResolver: TokenResolver): ObservabilityBuilder

Parameter

tokenResolver

TokenResolver

Funktion zum Auflösen von Authentifizierungstoken

Gibt zurück

Die Generatorinstanz für die Methodenkette