Builder class

Pakiet:

@microsoft/agents-a365-observability

Konstruktor do konfigurowania agenta 365 przy użyciu śledzenia OpenTelemetry

Metody

build()	Kompiluje i inicjuje konfigurację agenta 365
shutdown()	Zamyka zestaw OpenTelemetry SDK
start()	Uruchamia zestaw OpenTelemetry SDK
withClusterCategory(ClusterCategory)	Konfiguruje kategorię klastra dla eksportera agenta 365
withConfigurationProvider(IConfigurationProvider<ObservabilityConfiguration>)	Konfiguruje dostawcę konfiguracji dla opcji ObservabilityConfiguration. Po ustawieniu ten dostawca jest używany przez konstruktora i jego składniki wewnętrzne zamiast domyślnego dostawcy, który odczytuje ze zmiennych środowiskowych.
withCustomLogger(ILogger)	Ustawia niestandardową implementację rejestratora dla zestawu SDK do obserwacji
withExporterOptions(Partial<Agent365ExporterOptions>)	Podaj częściowy zestaw agentów365ExporterOptions. Zostaną one scalone z wartościami domyślnymi i wszystkie jawnie skonfigurowane klastryCategory/tokenResolver.
withService(string, string)	Konfiguruje nazwę i wersję usługi dla telemetrii
withServiceNamespace(string)	Konfiguruje przestrzeń nazw usługi dla telemetrii (atrybut zasobu service.namespace)
withTokenResolver(TokenResolver)	Konfiguruje moduł rozpoznawania tokenów dla eksportera agenta 365

Szczegóły metody

build()

Kompiluje i inicjuje konfigurację agenta 365

function build(): boolean

Zwraca

boolean

Skonfigurowane wystąpienie nodeSDK

shutdown()

Zamyka zestaw OpenTelemetry SDK

function shutdown(): Promise<void>

Zwraca

Promise<void>

start()

Uruchamia zestaw OpenTelemetry SDK

function start()

withClusterCategory(ClusterCategory)

Konfiguruje kategorię klastra dla eksportera agenta 365

function withClusterCategory(clusterCategory: ClusterCategory): ObservabilityBuilder

Parametry

clusterCategory

ClusterCategory

Kategoria klastra (np. "preprod", "prod")

Zwraca

Builder

Wystąpienie konstruktora służące do tworzenia łańcuchów metod

withConfigurationProvider(IConfigurationProvider<ObservabilityConfiguration>)

Konfiguruje dostawcę konfiguracji dla opcji ObservabilityConfiguration. Po ustawieniu ten dostawca jest używany przez konstruktora i jego składniki wewnętrzne zamiast domyślnego dostawcy, który odczytuje ze zmiennych środowiskowych.

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

Parametry

configProvider

IConfigurationProvider<ObservabilityConfiguration>

Dostawca konfiguracji

Zwraca

Builder

Wystąpienie konstruktora służące do tworzenia łańcuchów metod

withCustomLogger(ILogger)

Ustawia niestandardową implementację rejestratora dla zestawu SDK do obserwacji

function withCustomLogger(customLogger: ILogger): ObservabilityBuilder

Parametry

customLogger

ILogger

Implementacja niestandardowego rejestratora (musi implementować interfejs ILogger)

Zwraca

Builder

Wystąpienie konstruktora służące do tworzenia łańcuchów metod

Przykład z winstonem:

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

Podaj częściowy zestaw agentów365ExporterOptions. Zostaną one scalone z wartościami domyślnymi i wszystkie jawnie skonfigurowane klastryCategory/tokenResolver.

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

Parametry

exporterOptions

Partial<Agent365ExporterOptions>

Opcje częściowego eksportera

Zwraca

Builder

Wystąpienie konstruktora do tworzenia łańcuchów

withService(string, string)

Konfiguruje nazwę i wersję usługi dla telemetrii

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

Parametry

serviceName

string

Nazwa usługi

serviceVersion

string

Wersja usługi

Zwraca

Builder

Wystąpienie konstruktora służące do tworzenia łańcuchów metod

withServiceNamespace(string)

Konfiguruje przestrzeń nazw usługi dla telemetrii (atrybut zasobu service.namespace)

function withServiceNamespace(serviceNamespace: string): ObservabilityBuilder

Parametry

serviceNamespace

string

Przestrzeń nazw usługi

Zwraca

Builder

Wystąpienie konstruktora służące do tworzenia łańcuchów metod

withTokenResolver(TokenResolver)

Konfiguruje moduł rozpoznawania tokenów dla eksportera agenta 365

function withTokenResolver(tokenResolver: TokenResolver): ObservabilityBuilder

Parametry

tokenResolver

TokenResolver

Funkcja rozpoznawania tokenów uwierzytelniania

Zwraca

Builder

Wystąpienie konstruktora służące do tworzenia łańcuchów metod