MSIインストーラーを使用してCollector for Windowsをインストールする

MSIインストーラーを使用してSplunk Distribution of the OpenTelemetry Collector for Windowsをインストールする方法について説明します。

Windows MSIインストーラーを使用してSplunk Distribution of the Collector for Windowsをインストールできます。

注: Splunk Distribution of the OpenTelemetry Collector にはデフォルト設定が付属しています。詳しくは「Collector for Windows default configuration」をご確認ください。この設定を変更するには、「Windowsの詳細設定」を参照してください。ログを取得するには、「Windowsの Collector を使用したログの収集」を参照してください。

または、Collector for Windowsをインストールすることもできます。

前提条件

Windowsインストーラーファイルを使用してCollectorをインストールする

Windows Installer を使用してパッケージをインストールするには、Windows MSI パッケージ(64ビットのみ)を GitHub リリースサイトからダウンロードしてください。

  • パッケージは Program Files\Splunk\OpenTelemetry Collector にインストールされます。

  • splunk-otel-collector サービスは作成されますが、開始されません。

  • デフォルトの設定ファイルがまだ存在しない場合は、\ProgramData\Splunk\OpenTelemetry Collector\agent_config.yaml にコピーされます。このファイルは splunk-otel-collector サービスを開始するために必要となります。

注: Windows のデフォルト設定では ProgramData フォルダは非表示になっています。

次に、インストーラーのステップに従うか、Powershellターミナルを使ってインストールします。

グラフィカルインストーラーを使ってインストールする

ダウンロードしたパッケージを実行し、ガイドされたセットアップの指示に従ってください。

PowerShellターミナルを使用してインストールする

以下の手順に従ってください:

  1. PowerShellターミナルを開きます。

  2. 以下のコマンドを実行してください。ここで PATH_TO_MSI はダウンロードしたパッケージのフルパスです。たとえば、C:\your\download\folder\splunk-otel-collector-0.4.0-amd64.msi のようになります。

    POWERSHELL
    Start-Process -Wait msiexec "/i PATH_TO_MSI /qn"
  3. 以下の表に示す変数を使用してCollectorを設定します:

    POWERSHELL
    Start-Process -Wait msiexec "/i PATH_TO_MSI /qn SPLUNK_ACCESS_TOKEN=<my_access_token>"

    MSIデプロイの方法で以下のインストール設定を使用します:

    Name

    説明

    デフォルト

    COLLECTOR_SVC_ARGS

    Windows で Collector サービスを起動するために使用するコマンドライン引数を設定するよう Windows MSI に指示します。

    GOMEMLIMIT

    Go メモリ制限を設定し、ターゲットに近づくにつれて、より頻繁に実行するようにガベージコレクタに指示します。詳しくは「Update the Collector for Windows」を参照してください。

    バージョン 0.127.0 以降で使用できます。

    SPLUNK_ACCESS_TOKEN

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

    SPLUNK_API_URL

    Splunk API URL。

    https://api.[SPLUNK_REALM].signalfx.com

    SPLUNK_BUNDLE_DIR

    Smart Agentバンドルのパス。

    [INSTALLDIR]\OpenTelemetry Collector\agent-bundle

    SPLUNK_COLLECTD_DIR

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

    オプションです。msiexec コマンドに渡された場合のみ追加されます。

    SPLUNK_CONFIG

    Collectorカスタム設定ファイルの宛先パス。

    [CommonAppDataFolder]Splunk\OpenTelemetry Collector\[SPLUNK_SETUP_COLLECTOR_MODE]_config.yaml

    SPLUNK_GATEWAY_URL

    ゲートウェイモードのURL

    オプションです。msiexec コマンドに渡された場合のみ追加されます。

    SPLUNK_HEC_TOKEN

    Splunk HEC認証トークン。

    [SPLUNK_ACCESS_TOKEN]

    SPLUNK_HEC_URL

    Splunk HECエンドポイントURL。

    https://ingest.[SPLUNK_REALM].signalfx.com/v1/log

    SPLUNK_INGEST_URL

    SplunkインジェストURL。

    https://ingest.[SPLUNK_REALM].signalfx.com

    SPLUNK_LISTEN_INTERFACE

    エージェントレシーバーがリッスンするネットワーク・インターフェイス。

    オプションです。msiexec コマンドに渡された場合のみ追加されます。

    SPLUNK_MEMORY_LIMIT_MIB

    これを使用して、memory_limiter プロセッサーのメモリ制限を設定します。

    オプションです。msiexec コマンドに渡された場合のみ追加されます。

    SPLUNK_MEMORY_TOTAL_MIB

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

    オプションです。msiexec コマンドに渡された場合のみ追加されます。

    SPLUNK_REALM

    Splunkレルム。

    us0

    SPLUNK_SETUP_COLLECTOR_MODE

    Collector のデプロイモードを agent または gateway に設定するプロパティをインストールします。「Collector のデプロイモード」を参照してください。

    agent

    SPLUNK_TRACE_URL

    SplunkトレースエンドポイントURL。

    https://ingest.[SPLUNK_REALM].signalfx.com/v2/trace

  4. システムを再起動するか、PowerShellターミナルで以下のコマンドを実行して、splunk-otel-collector サービスを開始します:

    POWERSHELL
    Start-Service splunk-otel-collector

PowerShell での高度な設定オプション(サービスログ設定を含む)については、次のドキュメントを参照してください。

カスタムMSI URL

デフォルトでは、Collector MSI は https://dl.signalfx.com からダウンロードされます。

これらのダウンロードにカスタム URL を指定するには、COLLECTOR_MSI_URL をインストールする MSI パッケージの URL と置き換えてください。

POWERSHELL
& {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>"; Invoke-Command -ScriptBlock ([scriptblock]::Create(". {$script} $(&{$args} @params)"))}

Chocolateyパッケージを使用してCollectorをインストールする

Chocolatey パッケージをダウンロードしてインストールし、以下の PowerShell コマンドで Collector を設定することができます。

POWERSHELL
choco install splunk-otel-collector --params="'/SPLUNK_ACCESS_TOKEN:MY_SPLUNK_ACCESS_TOKEN /SPLUNK_REALM:MY_SPLUNK_REALM'"

次のステップ