Builder class

Paket:

@microsoft/agents-a365-observability

OpenTelemetry izleme ile Agent 365'i yapılandırmak için oluşturucu

Yöntemler

build()	Agent 365 yapılandırmasını oluşturur ve başlatır
shutdown()	OpenTelemetry SDK'sını kapatır
start()	OpenTelemetry SDK'sını başlatır
withClusterCategory(ClusterCategory)	Agent 365 vereni için küme kategorisini yapılandırıyor
withConfigurationProvider(IConfigurationProvider<ObservabilityConfiguration>)	Yapılandırma sağlayıcısını ObservabilityConfiguration için yapılandırılır. Bu sağlayıcı ayarlandığında, ortam değişkenlerinden okuyan varsayılan sağlayıcı yerine oluşturucu ve iç bileşenleri tarafından kullanılır.
withCustomLogger(ILogger)	Gözlemlenebilirlik SDK'sı için özel bir günlükçü uygulaması ayarlar
withExporterOptions(Partial<Agent365ExporterOptions>)	Kısmi bir Agent365ExporterOptions kümesi sağlayın. Bunlar varsayılanlar ve açıkça yapılandırılmış kümeCategory/tokenResolver ile birleştirilir.
withService(string, string)	Telemetri için hizmet adını ve sürümünü yapılandırıyor
withServiceNamespace(string)	Telemetri için hizmet ad alanını yapılandırıyor (service.namespace resource attribute)
withTokenResolver(TokenResolver)	Agent 365 veren için belirteç çözümleyicisini yapılandırıyor

Yöntem Ayrıntıları

build()

Agent 365 yapılandırmasını oluşturur ve başlatır

function build(): boolean

Döndürülenler

boolean

Yapılandırılan NodeSDK örneği

shutdown()

OpenTelemetry SDK'sını kapatır

function shutdown(): Promise<void>

Döndürülenler

Promise<void>

start()

OpenTelemetry SDK'sını başlatır

function start()

withClusterCategory(ClusterCategory)

Agent 365 vereni için küme kategorisini yapılandırıyor

function withClusterCategory(clusterCategory: ClusterCategory): ObservabilityBuilder

Parametreler

clusterCategory

ClusterCategory

Küme kategorisi (örn. "ön üretim", "prod")

Döndürülenler

Builder

Yöntem zincirleme için oluşturucu örneği

withConfigurationProvider(IConfigurationProvider<ObservabilityConfiguration>)

Yapılandırma sağlayıcısını ObservabilityConfiguration için yapılandırılır. Bu sağlayıcı ayarlandığında, ortam değişkenlerinden okuyan varsayılan sağlayıcı yerine oluşturucu ve iç bileşenleri tarafından kullanılır.

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

Parametreler

configProvider

IConfigurationProvider<ObservabilityConfiguration>

Yapılandırma sağlayıcısı

Döndürülenler

Builder

Yöntem zincirleme için oluşturucu örneği

withCustomLogger(ILogger)

Gözlemlenebilirlik SDK'sı için özel bir günlükçü uygulaması ayarlar

function withCustomLogger(customLogger: ILogger): ObservabilityBuilder

Parametreler

customLogger

ILogger

Özel günlükçü uygulaması (ILogger arabirimini uygulamalıdır)

Döndürülenler

Builder

Yöntem zincirleme için oluşturucu örneği

Winston ile örnek:

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

Kısmi bir Agent365ExporterOptions kümesi sağlayın. Bunlar varsayılanlar ve açıkça yapılandırılmış kümeCategory/tokenResolver ile birleştirilir.

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

Parametreler

exporterOptions

Partial<Agent365ExporterOptions>

Kısmi ihracatçı seçenekleri

Döndürülenler

Builder

Zincirleme için oluşturucu örneği

withService(string, string)

Telemetri için hizmet adını ve sürümünü yapılandırıyor

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

Parametreler

serviceName

string

Hizmet adı

serviceVersion

string

Hizmet sürümü

Döndürülenler

Builder

Yöntem zincirleme için oluşturucu örneği

withServiceNamespace(string)

Telemetri için hizmet ad alanını yapılandırıyor (service.namespace resource attribute)

function withServiceNamespace(serviceNamespace: string): ObservabilityBuilder

Parametreler

serviceNamespace

string

Hizmet ad alanı

Döndürülenler

Builder

Yöntem zincirleme için oluşturucu örneği

withTokenResolver(TokenResolver)

Agent 365 veren için belirteç çözümleyicisini yapılandırıyor

function withTokenResolver(tokenResolver: TokenResolver): ObservabilityBuilder

Parametreler

tokenResolver

TokenResolver

Kimlik doğrulama belirteçlerini çözümleme işlevi

Döndürülenler

Builder

Yöntem zincirleme için oluşturucu örneği