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

Ansible コレクションをインストールする前に、Splunk Distribution of the OpenTelemetry Collector の利用開始をチェックして必要なリソースを確認します：

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

対応バージョン 🔗

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

Windows Server 2016 64 ビット
Windows Server 2019 64 ビット
Windows Server 2022 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 ランタイムのメモリ使用量を制限し、ガベージコレクションを強化して、メモリ不足を防ぎます。詳細については、設定でメモリバラストを更新する方法を参照してください。デフォルト値は `splunk_total_mem_mib` の 90% です。
`splunk_access_token`	リクエストを認証する Splunk アクセストークン。この属性は必須です。
`splunk_realm`	データを送信するレルム。この変数はサービスに対してこの値が設定されます。デフォルト値は `us0` です。Splunk レルムを検索するには、レルムについての注意を参照してください。
`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ドキュメンテーションサイトにあります。
`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 から非推奨です。使用している場合は、設定の更新方法を参照してください。
`install_fluentd`	ログ収集のための Fluentd と依存関係をインストールまたは管理するオプションです。デフォルト値は `false` です。
`td_agent_version`	インストールされている td-agent (Fluentd パッケージ) のバージョン。
`splunk_fluentd_config`	リモートホスト上の Fluentd 設定ファイルへのパス。デフォルトは `%SYSTEMDRIVE%\opt\td-agent\etc\td-agent\td-agent.conf` です。
`splunk_fluentd_config_source`	リモートホストで `splunk_fluentd_config` で設定された値の代わりにアップロードされて設定される、コントロールホスト上の Fluentd 設定ファイルへのソースパス。この変数を、たとえば `./custom_fluentd_config.conf` のように、カスタムの Fluentd 設定を送信するために使います。デフォルト値は `""` で、何もコピーされず、`splunk_otel_collector_config` で設定された設定ファイルが使われます。

This page was last updated on 2024年04月16日.

Related Topics

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

対応バージョン 🔗

要件 🔗

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

設定変数 🔗

Was this topic useful?

Splunk

Related Topics