IM-Copilot テレメトリの外部送出設定¶

概要¶

IM-Copilot の可観測性が記録したトレースを、OpenTelemetry Protocol（OTLP）で外部の監視基盤へ送出する機能に関する設定です。

この設定ファイルでは、送出機能の有効・無効、送出の束ね方、送出先との通信（タイムアウト・再送）、およびプロキシの設定を行います。

本設定は配備単位の設定であり、1つのWARに収容するすべてのテナントに一律に適用されます。

送出先のURL・認証方式・認証情報・追加HTTPヘッダはテナントごとの設定であり、テナント環境セットアップまたはテナント設定の「テレメトリの外部送出設定」で設定します。これらは本設定ファイルには含まれません。

送出方式はOTLP/HTTP（http/protobuf）に固定されています。

モジュール	IM-Copilot モジュール
フォーマットファイル(xsd)	WEB-INF/schema/im-copilot-otlp-export-config.xsd
設定場所	WEB-INF/conf/im-copilot-otlp-export-config.xml

<?xml version="1.0" encoding="UTF-8"?>
<im-copilot-otlp-export-config xmlns="https://www.intra-mart.jp/im-copilot/im-copilot-otlp-export-config" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="https://www.intra-mart.jp/im-copilot/im-copilot-otlp-export-config ../schema/im-copilot-otlp-export-config.xsd ">

  <enabled>false</enabled>

  <batch>
    <max-queue-size>2048</max-queue-size>
    <max-export-batch-size>512</max-export-batch-size>
    <schedule-delay-millis>5000</schedule-delay-millis>
    <export-timeout-millis>30000</export-timeout-millis>
  </batch>

  <connection>
    <connect-timeout-millis>10000</connect-timeout-millis>
    <request-timeout-millis>10000</request-timeout-millis>
    <retry-max-attempts>5</retry-max-attempts>
    <retry-initial-backoff-millis>1000</retry-initial-backoff-millis>
    <retry-max-backoff-millis>5000</retry-max-backoff-millis>
    <retry-backoff-multiplier>1.5</retry-backoff-multiplier>
  </connection>

  <proxy>
    <host></host>
  </proxy>

</im-copilot-otlp-export-config>

すべての設定項目は省略できます。省略した項目には、各項目の「省略時のデフォルト値」が適用されます。

設定ファイルは配備時に読み込まれます。設定ファイルの変更を反映するには、アプリケーションサーバの再起動が必要です。

テナントごとの設定（送出先など）の変更は、再起動を行わなくても次回の送出から反映されます。

注意

設定ファイルはフォーマットファイル(xsd)で検証されます。

値の範囲から外れた値、定義されていないタグ、または順序の誤ったタグを1か所でも記述すると、設定ファイル全体の読み込みに失敗し、すべての項目に省略時のデフォルト値が適用されます。

「送出機能の有効化設定」のデフォルト値は false であるため、結果として送出機能が停止します。

設定ファイルが存在しない場合も同様に、送出機能は停止します。

可観測性の記録（データベースへの書き込み）と画面は通常どおり動作するため、送出機能の停止に気づきにくい点に注意してください。

設定ファイルの読み込みに失敗した場合は、ログに「W.IWP.COPILOT.OBSERVABILITY.00201 テレメトリ外部送出の基盤設定の読み込みに失敗しました。送出機能を無効にしました。」が出力されます。

特に「試行回数の上限設定」は 2 以上 5 以下の値のみ指定できます。

リファレンス¶