Docs » Splunk Distribution of the OpenTelemetry Collector の利用開始 » Collector for Windowsを使い始める » Collector for Windows を手動でインストールする

Collector for Windows を手動でインストールする 🔗

Collector for Windows を手動でインストールする前に、前提条件 を確認してください。

デフォルト設定の変更 🔗

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

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 プロセッサーのメモリ制限を設定します。デフォルトでは512MiB

いいえ

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。

注釈

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

プロキシ設定を構成する 🔗

OpenTelemetry Collector をインストールして実行するためのプロキシ設定を行うには、Collectorのプロキシ設定を構成する を参照してください。

Windowsインストーラファイル（MSI）のインストール 🔗

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 フォルダは非表示になっています。

次に、GUIで進めるか、Powershellターミナルを使ってインストールする指示に従います。

GUIを使ってインストールする 🔗

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

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

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

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

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

Start-Process -Wait msiexec "/i PATH_TO_MSI /qn"

  1. コンフィギュレーションファイルのすべての変数 を適宜更新します。

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

Start-Service splunk-otel-collector

PowerShell を使用した高度な設定オプション (Service Logging を含む) については、Splunk Distribution of OpenTelemetry Collector Windows マニュアル を参照してください。

ログ収集用にFluentd MSIをインストールする 🔗

デフォルトのログ収集 🔗

Windows Installer を使用して Collector をインストール、設定、起動します。Collector デフォルト設定ファイル \ProgramData\Splunk\OpenTelemetry Collector\agent_config.yaml は 127.0.0.1:8006 上のログイベントをリッスンし、Splunk Observability Cloud に送信します。

Fluentdによるログ収集 🔗

注釈

Fluentd でログ収集を設定するには、管理者である必要があります。

以下の手順を実行して、Fluentd をインストールし、collected ログイベントを Collector に転送します：

  1. Fluentd MSI バージョン4.0以上をインストールしてください。

  2. ログイベントを収集し、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 ` に内容をコピーします。

  3. Fluentd の設定ファイルに加えられた変更を適用するには、システムを再起動するか、fluentdwinsvc を再起動します。

- Stop-Service fluentdwinsvc
- Start-Service fluentdwinsvc

  1. \opt\td-agent\td-agent.log で、Fluentd のサービスログとエラーを表示します。

一般的な Fluentd の設定の詳細については、公式 Fluentd ドキュメント を参照してください。

Chocolateyパッケージを使ってインストールする 🔗

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

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

GitHubの パッケージ・パラメーター について詳しく学びます。

Dockerを使ってインストールする 🔗

以下のコマンドを実行して、最新のDockerイメージをデプロイします：

$ docker run --rm -e SPLUNK_ACCESS_TOKEN=12345 -e SPLUNK_REALM=us0  `
          -p 13133:13133 -p 14250:14250 -p 14268:14268 -p 4317:4317 -p 6060:6060  `
          -p 8888:8888 -p 9080:9080 -p 9411:9411 -p 9943:9943 `
          --name=otelcol quay.io/signalfx/splunk-otel-collector-windows:latest

バイナリファイルを使ってインストールする 🔗

バイナリファイルを使用して Collector をインストールするには、以下の手順に従います：

  1. GitHub リリース から、お使いのアーキテクチャーのバイナリをダウンロードしてください。

  2. 既存の設定ファイルまたはカスタム設定ファイルを使用していない場合は、Collector 用の デフォルト設定ファイル<https://github.com/signalfx/splunk-otel-collector/tree/main/cmd/otelcol/config/collector>` をダウンロードしてください。詳細は Collector for Windows のデフォルト設定 を参照してください。

  3. コマンドラインからバイナリを実行します：

# see available command-line options
PS> & '<download dir>\otelcol_windows_amd64.exe' --help
Usage of otelcol:
    --config string          Locations to the config file(s), note that only a single location can be set per flag entry e.g. --config=/path/to/first --config=path/to/second. (default "[]")
    --feature-gates string   Comma-delimited list of feature gate identifiers. Prefix with '-' to disable the feature. '+' or no prefix will enable the feature. (default "[]")
    --no-convert-config      Do not translate old configurations to the new format automatically. By default, old configurations are translated to the new format for backward compatibility.
    --set string             Set arbitrary component config property. The component has to be defined in the config file and the flag has a higher precedence. Array config properties are overridden and maps are joined. Example --set=processors.batch.timeout=2s (default "[]")
    -v, --version                Version of the collector.

# set the SPLUNK_REALM and SPLUNK_ACCESS_TOKEN env vars required in our default config files
PS> $env:SPLUNK_REALM = "<realm>"
PS> $env:SPLUNK_ACCESS_TOKEN = "<token>"

# start the collector
PS> & '<download dir>\otelcol_windows_amd64.exe' --config=<path to config file>

# alternatively, use the SPLUNK_CONFIG env var instead of the --config command-line option
PS> $env:SPLUNK_CONFIG = "<path to config file>"
PS> & '<download dir>\otelcol_windows_amd64.exe'

# type Ctrl-c to stop the collector

カスタム設定ファイルを使用する 🔗

カスタム構成ファイルを使用する場合は、そのファイルを含むディレクトリをマウントし、SPLUNK_CONFIG=<path> 環境変数または --config=<path> コマンドライン引数を使用します。<path> をコンテナ内のカスタム・ファイルへのパスに置き換えます。

構成ファイルをWindowsコンテナにマウントするには、構成ファイルが存在するディレクトリ名を指定します。

SPLUNK_CONFIG による例 🔗

$ docker run --rm -e SPLUNK_ACCESS_TOKEN=12345 -e SPLUNK_REALM=us0 `
          -e SPLUNK_CONFIG=c:\splunk_config\gateway_config.yaml -p 13133:13133  `
          -p 14250:14250 -p 14268:14268 -p 4317:4317 -p 6060:6060 -p 8888:8888 -p 9080:9080 `
          -p 9411:9411 -p 9943:9943 -v ${PWD}\splunk_config:c:\splunk_config:RO `
          --name otelcol quay.io/signalfx/splunk-otel-collector-windows:latest

--config による例 🔗

$ docker run --rm -e SPLUNK_ACCESS_TOKEN=12345 -e SPLUNK_REALM=us0 `
    -p 13133:13133 -p 14250:14250 -p 14268:14268 -p 4317:4317 -p 6060:6060 `
    -p 8888:8888 -p 9080:9080 -p 9411:9411 -p 9943:9943 `
    -v ${PWD}\splunk_config:c:\splunk_config:RO `
    --name otelcol quay.io/signalfx/splunk-otel-collector-windows:latest `
    --config c:\splunk_config\gateway_config.yaml

次のステップ 🔗

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

This page was last updated on 2024年04月23日.