Docs » Splunk Distribution of the OpenTelemetry Collector の利用開始 » Collector for Windowsを使い始める » インストーラ・スクリプトを使用して Collector for Windows をインストールします。

インストーラ・スクリプトを使用して Collector for Windows をインストールします。 🔗

The Splunk Distribution of the OpenTelemetry Collector for Windows is a package that provides integrated collection and forwarding for all data types. Read on to see how to install it using the installer script.

注釈

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:

前提条件 🔗

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以上が必要です。

含まれるパッケージ 🔗

Windows インストーラーのスクリプトは、以下のパッケージをインストールします:

Install the Collector for Windows using the installer script 🔗

このインストーラスクリプトは、Windows 64ビット環境で利用可能で、以下の展開と設定を行う:

  • Splunk Distribution of the OpenTelemetry Collector for Windows

  • td-agent を介してのFluentd。デフォルトでは無効になっています。

インストーラー・スクリプトを使用してパッケージをインストールするには、以下の手順に従ってください:

  1. ホストの管理者権限を持っていることを確認してください。

  2. ホスト上で以下の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"}; Invoke-Command -ScriptBlock ([scriptblock]::Create(". {$script} $(&{$args} @params)"))}

PowerShellでTLSを有効化する必要がある場合は、次のコマンドを使用します:

[Net.ServicePointManager]::SecurityProtocol = [Net.ServicePointManager]::SecurityProtocol -bor [Net.SecurityProtocolType]::Tls12

注意

Starting from version 0.89, the installer for the Splunk Distribution of the OpenTelemetry Collector for Windows sets its configuration using environment variables at service level instead of global level. To configure additional settings use service, process, or terminal scopes.

Collector 実行ファイルを手動で起動します。 🔗

予期しない起動失敗が発生した場合は、Collector実行ファイルを手動で起動してみてください。

そのためには、管理者として以下のPowerShellコマンドを実行します:

& 'C:\Program Files\Splunk\OpenTelemetry Collector\otelcol.exe' --config 'C:\ProgramData\Splunk\OpenTelemetry Collector\agent_config.yaml'

Windows用インストーラ・スクリプトのオプション 🔗

Windowsインストーラ・スクリプトは、以下のオプションをサポートしています:

オプション

説明

デフォルト値

access_token

メトリクスデータを Splunk に送信する際に使用するトークン。

realm

使用する Splunk レルム。インジェスト、API、トレース、HEC の各エンドポイント URL は、この値を使用して自動的に作成されます。Splunk レルムを見つけるには、レルムについての注意 を参照してください。

us0

memory

Collector に割り当てる MIB の合計メモリ。バラストサイズを自動的に計算します。詳細は、サイジングとスケーリング を参照してください。

512

mode

Collectorserviceをホストモニタリング( agent )またはデータ転送( gateway )で実行するように構成します。

agent

network_interface

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

0.0.0.0

ingest_url

指定されたレルムから推測されるURLの代わりに、ベースとなるインジェストURLを明示的に設定します。

https://ingest.REALM.signalfx.com

api_url

指定したレルムから推測されるURLの代わりに、ベースAPIのURLを明示的に設定します。

https://api.REALM.signalfx.com

trace_url

指定されたレルムから推測されるエンドポイントではなく、明示的にトレースエンドポイント URL を設定します。

https://ingest.REALM.signalfx.com/v2/trace

hec_url

指定されたレルムから推測されるエンドポイントではなく、明示的に HEC エンドポイント URL を設定します。

https://ingest.REALM.signalfx.com/v1/log

hec_token

HEC トークンが、指定した Splunk アクセストークンと異なる場合に設定します。

with_fluentd

ログイベントをコレクタに転送するために fluentd をインストールして設定するかどうか。詳細は Collect Windows logs with Fluentd を参照してください。

$false

with_dotnet_instrumentation

.NETアプリケーショントレースをローカルコレクタに転送するために、.NETトレースをインストールして構成するかどうか。

$false

deployment_env

.NET インストルメンテーションで使用されるシステム全体の環境タグ。SIGNALFX_ENV 環境変数を設定します。-with_dotnet_instrumentationfalse に設定されている場合は無視されます。

bundle_dir

モニター機能用のSmart Agent バンドルの場所。

C:\Program Files\Splunk\OpenTelemetry Collector\agent-bundle

insecure

trueの場合、リソースのダウンロード時に証明書はチェックされません。

$false

collector_version

インストールする Collector の特定のバージョンを指定します。

最新バージョン利用可能

stage

[ testbetarelease ] からインストールするパッケージ・ステージ。

release

collector_msi_url

Collector をインストールする場合、パッケージをダウンロードする代わりに、Splunk OpenTelemetry Collector MSI パッケージへのこのローカルパスを使用します。指定した場合、-collector_version-stage パラメータは無視されます。

https://dl.signalfx.com/splunk-otel-collector/
msi/release/splunk-otel-collector-<version>-amd64.msi

fluentd_msi_url

インストールするFluentd MSIパッケージのURLを指定します。

https://packages.treasuredata.com/4/windows/td-agent-4.1.0-x64.msi

msi_path

パッケージをダウンロードする代わりにインストールする Splunk OpenTelemetry Collector MSI パッケージへのローカルパスを指定します。指定した場合、-collector_version-stage パラメータは無視されます。

msi_public_properties

Splunk OpenTelemetry Collector MSI パッケージをインストールする際に使用するパブリック MSI プロパティを指定します。

Collect logs for the Collector for Windows 🔗

Use the Universal Forwarder to send logs to the Splunk platform. See more at Collector で Splunk Universal Forwarder を使用する.

Collect Windows logs with Fluentd 🔗

If you wish to collect logs for the target host with Fluentd, use the with_fluentd = 1 option to install and enable Fluentd when installing the Collector. For example:

& {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

次のステップ 🔗

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

This page was last updated on 2024年10月09日.