Builder class

パッケージ:

@microsoft/agents-a365-observability

OpenTelemetry トレースを使用してエージェント 365 を構成するためのビルダー

メソッド

build()	エージェント 365 構成をビルドして初期化する
shutdown()	OpenTelemetry SDK をシャットダウンします
start()	OpenTelemetry SDK を起動します
withClusterCategory(ClusterCategory)	エージェント 365 エクスポーターのクラスター カテゴリを構成します
withConfigurationProvider(IConfigurationProvider<ObservabilityConfiguration>)	ObservabilityConfiguration の構成プロバイダーを構成します。 設定すると、このプロバイダーは、環境変数から読み取る既定のプロバイダーではなく、ビルダーとその内部コンポーネントによって使用されます。
withCustomLogger(ILogger)	監視 SDK のカスタム ロガー実装を設定します
withExporterOptions(Partial<Agent365ExporterOptions>)	Agent365ExporterOptions の部分的なセットを指定します。 これらは、既定値と、明示的に構成された clusterCategory/tokenResolver とマージされます。
withService(string, string)	テレメトリのサービス名とバージョンを構成します
withServiceNamespace(string)	テレメトリのサービス名前空間を構成します (service.namespace リソース属性)
withTokenResolver(TokenResolver)	エージェント 365 エクスポーターのトークン リゾルバーを構成します

メソッドの詳細

build()

エージェント 365 構成をビルドして初期化する

function build(): boolean

返品

boolean

構成された NodeSDK インスタンス

shutdown()

OpenTelemetry SDK をシャットダウンします

function shutdown(): Promise<void>

返品

Promise<void>

start()

OpenTelemetry SDK を起動します

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 の部分的なセットを指定します。 これらは、既定値と、明示的に構成された clusterCategory/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

メソッド チェーンのビルダー インスタンス