Windows用Puppetを使用してコレクタをデプロイする

Splunk Observability Cloud OpenTelemetry Collector Puppet モジュールを Windows にインストールする方法を説明します。

このモジュールを活用し Windows に Collector をインストールして設定します。モジュールを Puppet Forge からダウンロードしてインストールします。モジュールをダウンロードした後、class パラメータを使用してカスタマイズを追加できます。

Windows システムでは、レジストリキーと値を設定するには puppetlabs/registry module が必要です。また、Powershell コマンドを実行するには puppetlabs/powershell module が必要です。

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

Puppetモジュールを使用する

このモジュールを使用するには、サポートされているパラメータを使用して、splunk_otel_collector クラスをマニフェストに含めます(使用可能なパラメータについては、「クラスパラメータを変更する」を参照してください)。たとえば、次のデプロイ定義は、デフォルトのパラメータを使用した最も単純なデプロイ定義です(VERSION を希望の Collector バージョンに、SPLUNK_ACCESS_TOKEN をリクエストを認証する Splunk アクセストークンに、SPLUNK_REALM をデータ送信先のレルムに置き換えてください)。

class { splunk_otel_collector:
  collector_version => 'VERSION'
  splunk_access_token => 'SPLUNK_ACCESS_TOKEN',
  splunk_realm => 'SPLUNK_REALM',
}

クラスのパラメータを変更する

このクラスは、以下の表に示すパラメータを受け付けます:

Name

説明

デフォルト値

collector_version

インストールする Collector パッケージのバージョンです。0.25.0 などを使用します。バージョン番号は、先頭の v を除いた GitHub リリースと一致している必要があります。属性は必須です。

なし

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 の取り込みと API のURL は、この値によって指定されます。SPLUNK_REALM 環境変数は、Collector サービス用にこの値で設定されます。属性は必須です。Splunk レルムを見つけるには、「Note about realms」を参照してください。

なし

splunk_ingest_url

$splunk_realm パラメータによって指定された URL の代わりに、Splunk の取り込み URL を明示的に設定します。SPLUNK_INGEST_URL 環境変数は、Collector サービス用にこの値で設定されます。

https://ingest.${splunk_realm}.signalfx.com

splunk_api_url

$splunk_realm パラメータによって推定される URL の代わりに、Splunk API の URL を明示的に設定します。SPLUNK_API_URL 環境変数は、Collector サービス用にこの値で設定されます。

https://api.${splunk_realm}.signalfx.com

splunk_trace_url

$splunk_ingest_url パラメータによって推定される URL の代わりに、Splunk トレースエンドポイントの URL を明示的に設定します。SPLUNK_TRACE_URL 環境変数は、Collector サービス用にこの値で設定されます。

${splunk_ingest_url}/v2/trace

splunk_hec_url

$splunk_ingest_url パラメータによって推定される URL の代わりに、Splunk HEC エンドポイントの URL を明示的に設定します。SPLUNK_HEC_URL 環境変数は、Collector サービス用にこの値で設定されます。

${splunk_ingest_url}/v1/log

splunk_hec_token

$splunk_access_token と異なる場合は、Splunk HEC 認証トークンを設定します。SPLUNK_HEC_TOKEN 環境変数は、Collector サービス用にこの値で設定されます。

$splunk_access_token

splunk_bundle_dir

Smart Agent バンドルディレクトリのパスです。デフォルトのパスは、Collector パッケージによって提供されます。指定するパスがデフォルト値から変更されている場合、パスはノード上の既存のディレクトリにする必要があります。Collector サービスでは、SPLUNK_BUNDLE_DIR 環境変数がこの値に設定されます。

%PROGRAMFILES%\Splunk\OpenTelemetry Collector\agent-bundle

splunk_collectd_dir

Smart Agent バンドル用の collectd 設定ディレクトリへのパスです。デフォルトのパスは、Collector パッケージによって提供されます。指定するパスがデフォルト値から変更されている場合、パスはノード上の既存のディレクトリにする必要があります。Collector サービスでは、SPLUNK_COLLECTD_DIR 環境変数がこの値に設定されます。

${splunk_bundle_dir}\run\collectd

splunk_memory_total_mib

Collector に割り当てる合計メモリ(MIB 単位)です。バラストサイズは自動的に計算されます。Collector サービスでは、SPLUNK_MEMORY_TOTAL_MIB 環境変数がこの値に設定されます。

512

splunk_ballast_size_mib

splunk_ballast_size_mib は Collector バージョン 0.97.0 以降では廃止されています。この変数を使用している場合は「設定の更新方法」を参照してください。

なし

collector_config_source

Collector 設定 YAML ファイルへのソースパス。このファイルは、ノードの $collector_config_dest パスにコピーされます。サポートされている値の種類については、ファイルリソースの「source 属性」を参照してください。デフォルトのソースファイルは、Collector パッケージによって提供されます。

%PROGRAMFILES\Splunk\OpenTelemetry Collector\agent_config.yaml

collector_config_dest

ノード上の Collector 構成ファイルの保存先パス。SPLUNK_CONFIG 環境変数は、Collector サービス用にこの値で設定されます。

%PROGRAMDATA%\Splunk\OpenTelemetry Collector\agent_config.yaml

次のステップ

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