Builder class

Пакет:

@microsoft/agents-a365-observability

Построитель для настройки агента 365 с помощью трассировки OpenTelemetry

Методы

build()	Создает и инициализирует конфигурацию агента 365
shutdown()	Завершает работу пакета SDK OpenTelemetry
start()	Запуск пакета SDK OpenTelemetry
withClusterCategory(ClusterCategory)	Настройка категории кластера для экспортера агента 365
withConfigurationProvider(IConfigurationProvider<ObservabilityConfiguration>)	Настраивает поставщик конфигурации для ObservabilityConfiguration. При установке этот поставщик используется построителем и его внутренними компонентами вместо поставщика по умолчанию, который считывается из переменных среды.
withCustomLogger(ILogger)	Задает реализацию пользовательского средства ведения журнала для пакета SDK для наблюдаемости
withExporterOptions(Partial<Agent365ExporterOptions>)	Укажите частичный набор Agent365ExporterOptions. Они будут объединены со значениями по умолчанию и любым явно настроенным кластеромCategory/tokenResolver.
withService(string, string)	Настраивает имя и версию службы для телеметрии
withServiceNamespace(string)	Настраивает пространство имен службы для телеметрии (атрибут ресурса service.namespace)
withTokenResolver(TokenResolver)	Настройка сопоставителя маркеров для экспортера агента 365

Сведения о методе

build()

Создает и инициализирует конфигурацию агента 365

function build(): boolean

Возвращаемое значение

boolean

Настроенный экземпляр NodeSDK

shutdown()

Завершает работу пакета SDK OpenTelemetry

function shutdown(): Promise<void>

Возвращаемое значение

Promise<void>

start()

Запуск пакета SDK OpenTelemetry

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

Экземпляр построителя для цепочки методов

Пример с 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)

Настройка сопоставителя маркеров для экспортера агента 365

function withTokenResolver(tokenResolver: TokenResolver): ObservabilityBuilder

Параметры

tokenResolver

TokenResolver

Функция для разрешения маркеров проверки подлинности

Возвращаемое значение

Builder

Экземпляр построителя для цепочки методов