Install the Collector for Windows using the MSI installer 🔗
You can use the Windows MSI installer to install the Splunk Distribution of the Collector for Windows.
注釈
The Splunk Distribution of the OpenTelemetry Collector comes with a default configuration, as detailed in Collector for Windows のデフォルト設定. To modify this configuration, refer to Windows用の高度な設定.
To learn how to obtain logs, see Collect logs for the Collector for Windows.
Alternatively, you can also install the Collector for Windows:
Using the installer script. See インストーラ・スクリプトを使用して Collector for Windows をインストールします。.
Using deployment tools. See Install the Collector for Windows using deployment tools.
Manually. See Collector for Windows を手動でインストールする.
前提条件 🔗
Collector は、インストール方法によって以下の Windows バージョンをサポートしています:
インストール方法 |
対応バージョン(64ビット) |
---|---|
インストーラ・スクリプト |
Windows 10 Pro および Home、Windows Server 2016、2019、2022 |
Windowsインストーラ(MSI) |
Windows 10 Pro および Home、Windows Server 2016、2019、2022 |
Ansible |
Windows 10 Pro および Home、Windows Server 2016、2019、2022 |
Chef |
Windows 10 Pro および Home、Windows Server 2019、2022 |
Nomad |
Windows 10 Pro および Home、Windows Server 2016、2019 |
Puppet |
Windows 10 Pro および Home、Windows Server 2016、2019 |
Docker |
Windows 10 Pro および Home、Windows Server 2019、2022 |
注釈
PowerShell 3.0以上が必要です。
Install the Collector using the Windows installer file (MSI) 🔗
To install the package using Windows Installer, download the Windows MSI package (64-bit only) from the Collector’s GitHub release site .
パッケージは
\Program Files\Splunk\OpenTelemetry Collector
にインストールされます。
splunk-otel-collector
サービスは作成されますが、開始されません。デフォルトの設定ファイルがまだ存在しない場合は、
\ProgramData\Splunk\OpenTelemetry Collector\agent_config.yaml
にコピーされます。このファイルは、splunk-otel-collector
サービスを開始するために必要です。
注釈
Windowsのデフォルトでは、ProgramData
フォルダは非表示になっています。
Next, follow the installer steps, or install the Collector using a PowerShell terminal.
Install using the graphical installer 🔗
ダウンロードしたパッケージを実行し、ガイドされたセットアップの指示に従ってください。
PowerShellターミナルを使用してインストールする 🔗
以下の手順に従ってください:
PowerShellターミナルを開きます。
以下のコマンドを実行してください。
PATH_TO_MSI
はダウンロードしたパッケージのフルパスです。例えば、C:\your\download\folder\splunk-otel-collector-0.4.0-amd64.msi
。Start-Process -Wait msiexec "/i PATH_TO_MSI /qn"
Configure the Collector using the variables listed in the table that follows:
Start-Process -Wait msiexec "/i PATH_TO_MSI /qn SPLUNK_ACCESS_TOKEN=<my_access_token>"
Use the following installation configurations with the MSI deployment method:
Name |
説明 |
デフォルト |
---|---|---|
|
The Splunk access token to authenticate requests. |
空 |
|
The Splunk API URL. |
|
|
The path to the Smart Agent bundle. |
|
|
Smart Agent の collectd config ディレクトリへのパス。例えば |
Optional. Only added if passed to msiexec command. |
|
Destination path of the Collector custom configuration file. |
|
|
URL in Gateway mode. |
Optional. Only added if passed to msiexec command. |
|
The Splunk HEC authentication token. |
|
|
The Splunk HEC endpoint URL. |
|
|
The Splunk ingest URL. |
|
|
The network interface the agent receivers listen on. |
Optional. Only added if passed to msiexec command. |
|
Use it to set the memory limit for the |
Optional. Only added if passed to msiexec command. |
|
Collector に割り当てるメモリの合計(MiB単位 |
Optional. Only added if passed to msiexec command. |
|
Your Splunk realm. |
|
|
Install property that sets the Collector’s deployment mode to either |
|
|
The Splunk trace endpoint URL. |
|
システムを再起動するか、PowerShellターミナルで以下のコマンドを実行して、
splunk-otel-collector
サービスを開始します:
Start-Service splunk-otel-collector
Learn more about advanced configuration options (including Service Logging) using PowerShell in the following docs:
ログ収集用にFluentd MSIをインストールする 🔗
If you have a wish to collect logs for the target host, make sure Fluentd is installed and enabled in your Collector instance.
注釈
Fluentd でログ収集を設定するには、管理者である必要があります。
以下の手順を実行して、Fluentd をインストールし、collected
ログイベントを Collector に転送します:
Fluentd MSI バージョン4.0以上をインストールしてください。
ログイベントを収集し、Collector に転送するように Fluentd を設定します:
オプション 1: 必要なログイベントを収集し、
127.0.0.1:8006
に転送するように、\opt\td-agent\etc\td-agent\td-agent.conf
にある Fluentd MSI によって提供されるデフォルトの設定ファイルを更新します。オプション 2: インストールされた Collector パッケージは、Windows イベントログ
\Program Files\Splunk\OpenTelemetry Collector\fluentd\conf.d\eventlog.conf
からログイベントを収集し、127.0.0.1:8006
に転送するために、カスタム Fluentd 設定ファイル\Program Files\Splunk\OpenTelemetry Collector\fluentd\td-agent.conf
を提供します。
これらのファイルを使用するには、
\opt\td-agent\etc\td-agent
` ディレクトリをバックアップし、\Program Files\Splunk\OpenTelemetry Collector\fluentd
` から\opt\td-agent\etc\td-agent
` に内容をコピーします。Fluentd の設定ファイルに加えられた変更を適用するには、システムを再起動するか、
fluentdwinsvc
を再起動します。
- Stop-Service fluentdwinsvc - Start-Service fluentdwinsvc
\opt\td-agent\td-agent.log
で、Fluentd のサービスログとエラーを表示します。
一般的な Fluentd の設定の詳細については、公式 Fluentd ドキュメント を参照してください。
カスタムMSI URL 🔗
デフォルトでは、Collector MSI は https://dl.signalfx.com からダウンロードされ、Fluentd MSI は https://packages.treasuredata.com からダウンロードされます。
To specify custom URLs for these downloads, replace COLLECTOR_MSI_URL
and FLUENTD_MSI_URL
with the URLs to the desired MSI packages to install:
& {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)"))}
Install the Collector using a Chocolatey package 🔗
Chocolatey パッケージ をダウンロードしてインストールし、以下の PowerShell コマンドで Collector と Fluentd を設定することができます:
choco install splunk-otel-collector --params="'/SPLUNK_ACCESS_TOKEN:MY_SPLUNK_ACCESS_TOKEN /SPLUNK_REALM:MY_SPLUNK_REALM'"
次のステップ 🔗
パッケージをインストールしたら、以下を参照してください:
View logs and errors in the Windows Event Viewer. Search for 「view logs and errors」 on the Microsoft documentation site for more information.