Windows用の高度な設定 🔗
Collectorにはデフォルト設定が付属しています。詳細は、Collector for Windows のデフォルト設定 を参照してください。
設定変数 🔗
Splunk 固有の環境変数を以下の表に示します:
Name |
説明 |
デフォルト設定は? |
---|---|---|
|
リクエストを認証するための Splunk アクセストークン |
はい |
|
Splunk API URL。たとえば、https://api.us0.signalfx.com |
はい |
|
|
いいえ |
|
Smart Agent バンドルのパス。例えば |
はい |
|
Smart Agent の collectd config ディレクトリへのパス。例えば |
はい |
|
Collectorカスタム設定ファイルの保存先パス |
いいえ |
|
カスタムコンフィギュレーションYAMLを指定します。これは基礎となるファイルシステムにアクセスしにくい環境で便利です。 |
いいえ |
|
デフォルトでは、Collector は http://localhost:55554/debug/configz/effective でリッスンしている、センシティブな値を再編集するローカルコンフィグサーバーを提供し、トラブルシューティングに役立ちます。これを無効にするには、 |
いいえ |
|
Splunk HEC 認証トークン |
はい |
|
Splunk HEC エンドポイント URL。たとえば、https://ingest.us0.signalfx.com/v1/log |
はい |
|
Splunk インジェスト URL。たとえば、https://ingest.us0.signalfx.com |
はい |
|
エージェントレシーバーがリッスンするネットワークインターフェイス。デフォルトでは |
はい |
|
これを使用して、 |
いいえ |
|
Collector に割り当てるメモリの合計(MiB単位 |
いいえ |
|
Splunk レルム |
いいえ |
|
Splunk トレースエンドポイント URL。たとえば、https://ingest.us0.signalfx.com/v2/trace |
はい |
SPLUNK_*_URL
環境変数は自動的に SPLUNK_REALM
から派生します。例えば、SPLUNK_INGEST_URL
= https://ingest.SPLUNK_REALM.signalfx.com。
デフォルトの設定ファイルを変更する 🔗
splunk-otel-collector
サービスを開始する前に、デフォルトの設定ファイルの変数を環境に適した値に変更します。指定されたインストールパラメーターに基づいて、環境変数が 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 のサイズについて詳しくは サイジングとスケーリング を参照してください。
プロキシ設定を構成する 🔗
OpenTelemetry Collector をインストールして実行するためのプロキシ設定を行うには、Collectorのプロキシ設定を構成する を参照してください。
カスタムMSI URL 🔗
デフォルトでは、Collector MSI は https://dl.signalfx.com からダウンロードされ、Fluentd MSI は https://packages.treasuredata.com からダウンロードされます。
これらのダウンロードにカスタムURLを指定するには、collector_msi_url
と fluentd_msi_url
オプションを使用します。COLLECTOR_MSI_URL
と FLUENTD_MSI_URL
を、インストールする MSI パッケージの URL に置き換えます:
& {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>"; collector_msi_url = "<COLLECTOR_MSI_URL>"; fluentd_msi_url = "<FLUENTD_MSI_URL>"}; Invoke-Command -ScriptBlock ([scriptblock]::Create(". {$script} $(&{$args} @params)"))}
ログ収集のためにFluentdを設定する 🔗
Log Observer 権限を持っているか、Fluentd でターゲットホストのログを収集したい場合は、Collector をインストールするときに with_fluentd = 1
オプションを使用して Fluentd もインストールします。例:
& {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>"; with_fluentd = 1}; Invoke-Command -ScriptBlock ([scriptblock]::Create(". {$script} $(&{$args} @params)"))}
有効にすると、Fluentdサービスはデフォルトで、@SPLUNK
ラベルのログイベントを収集し、Collector に転送するように設定され、Collector は realm = "<SPLUNK_REALM>"
オプションで決定されたHECインジェスト・エンドポイントにこれらのイベントを送ります。例えば、https://ingest.<SPLUNK_REALM>.signalfx.com/v1/log
。
<SPLUNK_ACCESS_TOKEN>
と異なるトークンを持つカスタム HTTP Event Collector (HEC) エンドポイント URL にログイベントを送信するようにパッケージを構成するには、インストーラ・スクリプトに次のパラメータを指定します:
hec_url = "<SPLUNK_HEC_URL>"
hec_token = "<SPLUNK_HEC_TOKEN>"
例(コマンドの <SPLUNK...>
の値は、コンフィギュレーションに合わせて置き換えてください):
& {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>"; hec_url = "<SPLUNK_HEC_URL>"; hec_token = "<SPLUNK_HEC_TOKEN>"}; Invoke-Command -ScriptBlock ([scriptblock]::Create(". {$script} $(&{$args} @params)"))}
インストールは、メインの fluentd 設定ファイル <drive>\opt\td-agent\etc\td-agent\td-agent.conf
を作成します。<drive>
は、fluentd インストールディレクトリのドライブ文字です。
インストール後、<drive>\opt\td-agent\etc\td-agent\conf.d
ディレクトリにカスタム fluentd ソース設定ファイルを追加することができます。
次のことに注意してください:
このディレクトリでは、fluentdは拡張子が.confのファイルをすべて含みます。
デフォルトでは、fluentd は Windows イベントログから収集します。デフォルトの設定は
<drive>\opt\td-agent\etc\td-agent\conf.d\eventlog.conf
を参照してください。
構成を変更したら、システムを再起動するか、以下のPowerShellコマンドを実行して変更を適用します:
Stop-Service fluentdwinsvc
Start-Service fluentdwinsvc
コマンドラインオプション 🔗
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