ログ用の OpenTelemetry コンフィギュレーション

ThingWorx のオブザーバビリティ > ThingWorx Platform でのログ作成における OpenTelemetry のサポート > ログ用の OpenTelemetry コンフィギュレーション

platform-settings.json ファイルの BasicSettings セクションでは、次の OpenTelemetry コンフィギュレーション設定を使用できます。

設定	タイプ	デフォルト値	説明
EnableOpenTelemetryForLogging	BOOLEAN	false	OpenTelemetry Collector を有効にするには、この値を true に設定します。 ThingWorx Platform サーバーが起動すると、OpenTelemetry Collector と ThingWorx Platform サーバーとの接続が確立されます。
DisableFileLogging	BOOLEAN	false	この値を true に設定すると、次のようになります。 • ログは /ThingworxStorage/logs フォルダには書き込まれません。 • ログは「Composer」 > 「監視」ページに表示されません。 • 「Composer」 > 「監視」ページに次のメッセージが表示されます。 Logging is disabled. Please refer to ThingWorx Platform configuration file to enable it. この設定では ThingWorx 内部ログのみが停止します。外部ログなど logback.xml を使用して設定されたログは、引き続き機能します。 Console logs ログおよび HTTP.out ログは影響を受けず、引き続き機能します。

DisableFileLogging を true に設定し、EnableOpenTelemetryForLogging を false に設定すると、次のようになります。

• 「Composer」 > 「監視」ページに次のメッセージが表示されます。

Logging is disabled. Please refer to platform configuration file to enable it.

• ログ取得ストラテジーは DefaultLogRetrievalStrategy に設定されます。

DisableFileLogging を false に設定し、EnableOpenTelemetryForLogging を true に設定した場合、ログはプラットフォーム上の ThingWorx ログファイルと、OpenTelemetry に統合されているサードパーティ製ソフトウェアで確認できます。

OpenTelemetry SDK コンフィギュレーション

platform-settings.json ファイルの OpenTelemetrySettings セクションでは、次の OpenTelemetry コンフィギュレーション設定を使用できます。

設定	デフォルト値	説明
BatchLogProcessorMaxQueueSize	2048	処理およびエクスポートの前に、キューに入れることができるログレコードの最大数。値を大きくするとスループットは増加しますが、より多くのメモリが必要になります。
BatchLogProcessorScheduledDelay	10 ミリ秒	プロセッサがログの新しいバッチをエクスポートするまで待機する時間 (ミリ秒単位)。バッチがいっぱいでない場合でも、この時間後にエクスポートされます。
BatchLogProcessorMaxExportBatchSize	512	1 回のエクスポートバッチで送信するログエントリの最大数。この設定は、ペイロードのサイズとネットワーク使用率を制御するのに役立ちます。
BatchLogProcessorExportTimeout	1000 ミリ秒	ログのエクスポートリクエストが完了するまでシステムが待機する時間 (ミリ秒単位)。リクエストはこの時間後にタイムアウトします。
OtlpGRPCLogExporterEndpoint		ThingWorx Platform がログをエクスポートする OTLP gRPC エンドポイントの URL (例: http://localhost:4317)。OpenTelemetry Collector または OTLP gRPC 互換バックエンドを介したリモートログの取得に必要です。
OtlpGRPCEnableSSL	false	OTLP gRPC ログエクスポートの SSL/TLS を有効または無効にできます。 • true - 安全な伝送を使用します。 • false - プレーンテキストを使用します。
OtlpGRPCTrustStorePath	該当なし	SSL 通信中に OpenTelemetry Collector またはターゲットバックエンドを検証するための、信頼できる証明書を含むトラストストアファイルへのパス。
OtlpGRPCTrustStorePassword	該当なし	OtlpGRPCTrustStorePath で設定されているトラストストアにアクセスするためのパスワード。
OtlpGRPCKeyStorePath	該当なし	相互 TLS (mTLS) のクライアント証明書と秘密キーを含むキーストアファイルへのパス。
OtlpGRPCKeyStorePassword	該当なし	OtlpGRPCKeyStorePath で設定されているキーストアにアクセスするためのパスワード。
RetryOtlpGRPCLogExporterMaxAttempts	5	一時的なエラーが原因でログのエクスポートが失敗した場合の、再試行の最大回数。
RetryOtlpGRPCLogExporterBackOffMultiplier	1.5	指数バックオフの計算に使用する乗数。データエクスポートが失敗するたびに、待機時間がこの係数ずつ増加します。
RetryOtlpGRPCLogExporterInitialBackOff	1 秒	最初の再試行までの時間 (秒単位)。
RetryOtlpGRPCLogExporterMaxBackOff	5 秒	指数バックオフ中の再試行の間隔 (秒単位)。
OtlpGRPCMetricExporterEndpoint	該当なし	ThingWorx Platform が判定基準をエクスポートする OTLP gRPC エンドポイントの URL (例: http://localhost:4317)。この URL は、OpenTelemetry Collector または OTLP gRPC 互換バックエンドを介した判定基準の取得に必要です。
EnableOpenTelemetryInternalMetrics	true	OpenTelemetry Collector を介したオブザーバビリティプラットフォームへの判定基準の送信を有効にします。