Docs » Splunk Distribution of the OpenTelemetry Collector の利用開始 » Collector for Windowsを使い始める » Install the Collector for Windows using deployment tools » Deploy the Collector for Windows with Chef

Deploy the Collector for Windows with Chef 🔗

Chef は、物理マシンや仮想マシン上のインフラを管理するために使われる構成管理技術です。Chef は Cookbook を使ってシナリオを定義します。

CookbookはChefの基本的な作業単位で、作業単位に関連するすべての詳細から構成され、Chefインフラストラクチャ上でノードとして構成されたシステムの設定や状態を変更する機能を持ちます。Cookbookは複数のタスクを実行できます。

前提条件 🔗

Chefを使うには以下のリソースが必要です：

Windows 🔗

以下のWindowsバージョン。すべてのバージョンでPowerShell 3.0以降を使用する必要があります。

  • Windows Server 2019 64 ビット

  • Windows Server 2022 64-bit

注意

Windowsでは、CollectorはWindowsサービスとしてインストールされ、その環境変数はサービススコープで設定されるため、Collectorサービスでのみ使用でき、マシン全体では使用できません。

ChefでCollectorをインストールして使う 🔗

コミュニティの Cookbook のサイトである Chef Supermarket から Chef Cookbook をダウンロードしてください。

Collector をインストールするには、run_list に splunk_otel_collector::default レシピをインクルードし、ノードの run_state に属性を設定します。以下は、必須の splunk_access_token 属性とオプションの属性を設定する方法を示す設定例です：

{
    "splunk-otel-collector": {
        "splunk_access_token": "<SPLUNK_ACCESS_TOKEN>",
        "splunk_realm": "<SPLUNK_REALM>",
    }
}

Configure automatic discovery for SignalFx .NET 🔗

You can automatically instrument your .NET applications along with the Collector installation using automatic discovery. Automatic discovery removes the need to install and configure the SignalFx .NET agent separately. See Automatic discovery of apps and services for more information.

Cookbook は以下の表に示す属性を受け入れます：

Name

説明

デフォルト値

with_signalfx_dotnet_instrumentation

Whether to install or manage automatic discovery for .NET. When set to true, the signalfx-dotnet-tracing MSI package will be downloaded and installed, and the Windows registry will be updated based on other configuration options. To learn more, see Zero-code instrumentation for back-end applications in Windows

false

signalfx_dotnet_auto_instrumentation_version

ダウンロードしてインストールする signalfx-dotnet-tracing MSI パッケージのバージョン。

1.1.0

signalfx_dotnet_auto_instrumentation_msi_url

カスタムホストから MSI をダウンロードする URL を指定します (例: https://my.host/signalfx-dotnet-tracing-1.0.0-x64.msi )。指定した場合、signalfx_dotnet_auto_instrumentation_version オプションは無視されます。

https://github.com/signalfx/signalfx-dotnet-tracing/releases/download/v{{ signalfx_dotnet_auto_instrumentation_version }}/signalfx-dotnet-tracing-{{ signalfx_dotnet_auto_instrumentation_version }}-x64.msi

signalfx_dotnet_auto_instrumentation_iisreset

デフォルトでは、iisreset.exe コマンドがインストール/設定後に実行され、IIS アプリケーションに変更が反映されます。IIS が個別に管理されているか、適用されない場合は、このオプションを false に設定して、この手順をスキップします。

false

signalfx_dotnet_auto_instrumentation_system_wide

Whether to configure automatic discovery for all .NET applications on the node. When set to true, all attributes and environment variables are added to the HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control\Session Manager\Environment registry key.

false

signalfx_dotnet_auto_instrumentation_environment

Splunk APM に報告されるデプロイメント環境変数を設定します (例: production )。この値は Windows レジストリの SIGNALFX_ENV 環境変数に割り当てられます。

''

signalfx_dotnet_auto_instrumentation_service_name

インストルメンテーションされたアプリケーションのサービス名を設定します。例： my-service。この値はWindowsレジストリの SIGNALFX_SERVICE_NAME 環境変数に割り当てられます。

''

signalfx_dotnet_auto_instrumentation_enable_profiler

AlwaysOn Profiling を有効または無効にします。この値は、Windows レジストリの SIGNALFX_PROFILER_ENABLED 環境変数に割り当てられます。

false

signalfx_dotnet_auto_instrumentation_enable_profiler_memory

AlwaysOn Memory Profiling を有効または無効にします。この値は、Windows レジストリの SIGNALFX_PROFILER_MEMORY_ENABLED 環境変数に割り当てられます。

false

signalfx_dotnet_auto_instrumentation_additional_options

上記のオプションに加えて、Windowsレジストリに追加するオプションのハッシュ。詳しくは SignalFx Instrumentation for .NETの設定 を参照してください。

{}

追加の環境変数 🔗

CollectorのサービスにCollector 設定ファイルから追加の環境変数を含めるには、collector_additional_env_vars を使用します。デフォルトでは {} です。

たとえば、Collector の設定ファイルに ${MY_CUSTOM_VAR1} と ${MY_CUSTOM_VAR2} への参照が含まれている場合、Collector サービスがこれらの変数を展開できるようにするには、次のように指定します：

collector_additional_env_vars: {'MY_CUSTOM_VAR1' => 'value1', 'MY_CUSTOM_VAR2' => 'value2'}

Linuxでは、変数/値は /etc/otel/collector/splunk-otel-collector.conf systemd環境ファイルに追加されます。

Windows では、変数/値は HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\splunk-otel-collector レジストリキーの下の Environment 値に追加されます。

次のステップ 🔗

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

このページは 2024年12月09日 に最終更新されました。