Windows用の高度な設定

OpenTelemetry Collector for Windows の Splunk ディストリビューションのオプション設定。

Collector にはデフォルト設定が付属します。詳しくは「Collector for Windows のデフォルト設定」をご確認ください。

Collector for Windowsのデフォルトの設定ファイルを変更する

すべてのインストール方法で、環境変数を使用したデフォルト設定が提供されます。splunk-otel-collector サービスを開始する前に、デフォルトの設定ファイル内の変数を、使用環境に適した値に置き換えてください。

Splunk 固有の環境変数を以下の表に示します：

Name

説明

デフォルト設定は？

SPLUNK_ACCESS_TOKEN

リクエストを認証するための Splunk アクセストークン

あり

SPLUNK_API_URL

Splunk API URL。たとえば、https://api.us0.signalfx.com

あり

SPLUNK_BALLAST_SIZE_MIB (非推奨)

memory_ballast は廃止されました。この変数を使用している場合は、設定を更新する方法を参照してください。

いいえ

SPLUNK_BUNDLE_DIR

Smart Agentバンドルのパス。たとえば、 /usr/lib/splunk-otel-collector/agent-bundle

あり

SPLUNK_COLLECTD_DIR

Smart Agent の collectd config ディレクトリへのパス。たとえば、 /usr/lib/splunk-otel-collector/agent-bundle/run/collectd

あり

SPLUNK_CONFIG

Collectorカスタム設定ファイルの保存先パス

いいえ

SPLUNK_CONFIG_YAML

カスタム構成 YAML を指定します。この変数は、基礎となるファイルシステムにアクセスしにくい環境で便利です

いいえ

SPLUNK_DEBUG_CONFIG_SERVER

デフォルトでは、Collector は http://localhost:55554/debug/configz/effective でリッスン中の、センシティブな値を再編集するローカル構成サーバーを提供し、トラブルシューティングに役立ちます。無効にするには、 SPLUNK_DEBUG_CONFIG_SERVER を true 以外の任意の値に設定します。目的のポートでリッスンさせるには、SPLUNK_DEBUG_CONFIG_SERVER_PORT を使用します

いいえ

SPLUNK_HEC_TOKEN

Splunk HEC 認証トークン

あり

SPLUNK_HEC_URL

Splunk HECエンドポイントURL。たとえば、https://ingest.us0.signalfx.com/v1/log

あり

SPLUNK_INGEST_URL

SplunkインジェストURL。たとえば、https://ingest.us0.signalfx.com

あり

SPLUNK_LISTEN_INTERFACE

エージェントレシーバーがリッスンするネットワーク・インターフェイス。デフォルトでは 0.0.0.0

あり

SPLUNK_MEMORY_LIMIT_MIB

これを使用して、memory_limiter プロセッサーのメモリ制限を設定します。デフォルトで 512 MiB

いいえ

SPLUNK_MEMORY_TOTAL_MIB

Collector に割り当てるメモリの合計（MiB単位

いいえ

SPLUNK_REALM

Splunk レルム

いいえ

SPLUNK_TRACE_URL

SplunkトレースエンドポイントURL。たとえば、https://ingest.us0.signalfx.com/v2/trace

あり

SPLUNK_*_URL 環境変数は SPLUNK_REALM から自動的に導出されます。たとえば、SPLUNK_INGEST_URL = https://ingest.SPLUNK_REALM.signalfx.com。

注: 追加設定を構成する場合は、サービス、プロセス、またはターミナルスコープを使用します。

指定されたインストールパラメータに基づいて、環境変数が HKLM:\SYSTEM\CurrentControlSet\Services\splunk-otel-collector レジストリキーに保存され、Environment エントリに設定されます。

設定値を変更するには、regedit を実行し、パスをブラウズします。

メモリ割り当てを設定する

メモリ割り当てを設定するには、環境変数 SPLUNK_MEMORY_TOTAL_MIB を設定する memory パラメータを使用します。

  • デフォルトでは、Collector は 512 MiB のメモリを使用するように設定されています。

  • この設定を変更するには、SPLUNK_MEMORY_TOTAL_MIB を希望の整数値に置き換えます。

& {Set-ExecutionPolicy Bypass -Scope Process -Force; $script = ((New-Object System.Net.WebClient).DownloadString('https://dl.signalfx.com/splunk-otel-collector.ps1')); $params = @{access_token = "SPLUNK_ACCESS_TOKEN"; realm = "SPLUNK_REALM"; memory = "SPLUNK_MEMORY_TOTAL_MIB"}; Invoke-Command -ScriptBlock ([scriptblock]::Create(". {$script} $(&{$args} @params)"))}

Collector のサイジングについて、詳しくは「Sizing and scaling」を参照してください。

プロキシ設定を構成する

OpenTelemetry Collector をインストールして実行するためのプロキシ設定を行うには、「Configure proxy settings for the Collector」を参照してください。

コマンドラインオプション

splunk-otel-collector サービスのコマンドラインオプションを追加または削除するには、regedit を実行し、HKLM:\SYSTEM\CurrentControlSet\Services\splunk-otel-collector レジストリキーの ImagePath の値を変更します。

あるいは、OPTIONS を希望のコマンドラインオプションに置き換えて、以下のPowerShellコマンドを実行します：

Set-ItemProperty -path "HKLM:\SYSTEM\CurrentControlSet\Services\splunk-otel-collector" -name "ImagePath" -value "C:\Program Files\Splunk\OpenTelemetry Collector\otelcol.exe OPTIONS"

たとえば、Collector のデフォルトの公開メトリクスアドレスを 0.0.0.0:9090 に変更するには、次のPowerShellコマンドを実行します：

Set-ItemProperty -path "HKLM:\SYSTEM\CurrentControlSet\Services\splunk-otel-collector" -name "ImagePath" -value "C:\Program Files\Splunk\OpenTelemetry Collector\otelcol.exe --metrics-addr 0.0.0.0:9090"

変更を適用する

設定ファイルまたはレジストリキーを変更したら、システムを再起動するか、以下のPowerShellコマンドを実行して変更を適用します：

Stop-Service splunk-otel-collector
Start-Service splunk-otel-collector

利用可能なコマンドラインオプション

利用可能なコマンドラインオプションをすべて表示するには、以下のPowerShellコマンドを実行します：

& 'C:\Program Files\Splunk\OpenTelemetry Collector\otelcol.exe' --help