Ansible for WindowsでCollectorをデプロイする

Splunk Observability Cloud OpenTelemetry Collector Ansible ロールを Windows にインストールする方法を説明します。

Ansible コレクションをインストールする前に、「Get started with the Splunk Distribution of the OpenTelemetry Collector」を参照して必要なリソースを確認してください。

Splunk アクセストークンを検索する
Splunk レルムを検索する
公開ポートを確認し、使用環境にコンフリクトがないことを確認してください。ポートはパッケージ設定から変更できます。

対応バージョン

現在、以下のWindowsバージョンに対応しています：

Windows Server 2016 64 ビット
Windows Server 2019 64 ビット
Windows Server 2022 64-bit
Windows Server 2025 64-bit

要件

Ansibleには、WindowsホストにPowerShell 3.0以上と.NET 4.0以上がインストールされている必要があります。

WinRMリスナーを作成し、有効化する必要があります。

Windows ホストのセットアップに関する情報は、Ansible ドキュメントサイトから確認できます。

AnsibleでCollectorをインストールして使用する

注意: Windows では、Collector は Windows サービスとしてインストールされ、その環境変数はサービススコープで設定されるため、Collector サービスでのみ使用でき、マシン全体では使用できません。

以下のコマンドを実行して、Ansible GalaxyからAnsibleコレクションをインストールします：

ansible-galaxy collection install signalfx.splunk_otel_collector

Splunk OpenTelemetry Collector ロールを使用するには、プレイブックに signalfx.splunk_otel_collector.collector role 呼び出しを含めてください。ロールにはルートアクセスが必要となります。詳しくは「Splunk OpenTelemetry Collector Ansible Role」をご確認ください。

以下の例では、必要最小限の構成を持ってプレイブック内でこのロールを使用する方法を示します：

- name: Install the Splunk Distribution of OpenTelemetry Collector
  hosts: all
  become: yes
  # For Windows "become: yes" will raise error.
  # "The Powershell family is incompatible with the sudo become plugin". Remove "become: yes" tag to run on Windows
  tasks:
    - name: "Include splunk_otel_collector"
      include_role:
        name: "signalfx.splunk_otel_collector.collector"
      vars:
        splunk_access_token: YOUR_ACCESS_TOKEN
        splunk_hec_token: YOUR_HEC_TOKEN
        splunk_realm: SPLUNK_REALM

なお、splunk_hec_yoken はオプションです。

設定変数

次の表は、このロールに設定できる変数について説明したものです：


変数	説明
`gomemlimit`	Collector バージョン 0.97.0 以降で、`splunk_ballast_size_mib` に置き換わります。GO ランタイムでのメモリ使用量を制限できるようにし、ガベージコレクションの効率を向上させ、メモリ不足の状況を防ぐのに役立ちます。詳細については、「how to update memory ballast in your configuration」を参照してください。デフォルト値は `splunk_total_mem_mib` の 90% です。
`splunk_access_token`	リクエストを認証するためのSplunkアクセストークン。属性は必須です。
`splunk_realm`	データ送信先のレルムです。この変数は、サービスのこの値で設定されます。デフォルト値は `us0` です。Splunk レルムを見つけるには、「Note about realms」を参照してください。
`splunk_ingest_url`	Splunk インジェスト URL です。`https://ingest.us0.signalfx.com` などを使用します。この変数は、サービスのこの値で設定されます。デフォルト値は `https://ingest.{{ splunk_realm }}.signalfx.com` です。
`splunk_api_url`	Splunk API の URL です。`https://api.us0.signalfx.com` などを使用します。この変数は、サービスのこの値で設定されます。デフォルト値は `https://api.{{ splunk_realm }}.signalfx.com` です。
`splunk_trace_url`	Splunk トレースエンドポイント URL です。`https://ingest.us0.signalfx.com/v2/trace` などを使用します。この変数は、サービスのこの値で設定されます。デフォルト値は `{{ splunk_ingest_url }}/v2/trace` です。
`splunk_hec_url`	Splunk HEC エンドポイント URL です。`https://ingest.us0.signalfx.com/v1/log` などを使用します。この変数は、サービスのこの値で設定されます。デフォルト値は `{{ splunk_ingest_url }}/v1/log` です。
`splunk_otel_collector_version`	インストールするパッケージのバージョンです。`0.25.0` などを使用します。デフォルト値は `latest` です。
`splunk_otel_collector_config`	YAML で作成される設定ファイルです。この変数を `%ProgramData%\Splunk\OpenTelemetry Collector\gateway_config.yaml` に設定することで、パッケージをデータ転送（ゲートウェイ）モードでインストールできます。デフォルトの場所は `%ProgramData%\Splunk\OpenTelemetry Collector\agent_config.yaml` です。
`splunk_config_override`	デフォルトのコンフィギュレーションにマージされるカスタムコンフィギュレーション。
`splunk_config_override_list_merge`	`splunk_config_override` のリストとデフォルト設定のリストをマージするための `list_merge` オプション設定に使用される変数です。適用可能オプションは、`replace`、`keep`、`append`、`prepend`、`append_rp`、または `prepend_rp` です。デフォルト値は `replace` です。この変数に関して、詳しくは「Ansible Documentation site」をご確認ください。
`splunk_otel_collector_config_source`	これは、制御ホスト上の設定ファイルのソースパスで、リモートホスト上の `splunk_otel_collector_config` に設定されている値の代わりにアップロードされて配置されます。この変数は、`./custom_collector_config.yaml` などのカスタム設定の送信に使用できます。デフォルト値は `""`です。これは、何もコピーされず、`splunk_otel_collector_config` で設定された構成ファイルが使用されることを表します。
`splunk_bundle_dir`	バンドルディレクトリへのパスです。デフォルトのパスは、パッケージによって提供されます。指定するパスがデフォルト値から変更されている場合、パスはノード上の既存のディレクトリにする必要があります。この変数は、サービスのこの値で設定されます。デフォルトの場所は `%ProgramFiles%\Splunk\OpenTelemetry Collector\agent-bundle` です。
`splunk_collectd_dir`	バンドル用の collectd 設定ディレクトリへのパスです。デフォルトのパスは、パッケージによって提供されます。指定するパスがデフォルト値から変更されている場合、パスはノード上の既存のディレクトリにする必要があります。この変数は、サービスのこの値で設定されます。デフォルトの場所は `%ProgramFiles%\Splunk\OpenTelemetry Collector\agent-bundle\run\collectd` です。
`splunk_memory_total_mib`	割り当てられたメモリの量（MiB 単位）です。デフォルト値は `512`、つまり 500 x 2^20 バイトのメモリです。
`splunk_ballast_size_mib`	`splunk_ballast_size_mib` は Collector バージョン 0.97.0 以降では廃止されています。この変数を使用している場合は「設定の更新方法」を参照してください。

次のステップ

パッケージをインストールしたら、以下を参照してください：

Collector for Linux のデフォルト設定。
Windows用の高度な設定。
Collector を使用します：一般的なタスクの実行方法。
Splunk Infrastructure Monitoring でナビゲーターを使用する。
Windows Event Viewer でログとエラーを表示します。詳細は、Microsoft のドキュメントサイトで「view logs and errors」を検索してください。