Windows 用 Agent の基本的な使用方法
Dash が新機能を発表!インシデントマネジメント、Continuous Profiler など多数の機能が追加されました! Dash イベントで発表された新機能!

Windows 用 Agent の基本的な使用方法

セットアップ

Datadog Agent をまだインストールしていない場合は、以下の手順またはアプリ内のインストール手順を参照してください。サポートされる OS バージョンについては、Agent のドキュメントを参照してください。

Datadog EU サイトへのインストールと構成には、SITE= パラメーターを使用します。以下の構成変数の表を参照してください。

インストール

Agent v6.11.0 以降、Windows Agent のコアと APM/トレースコンポーネントは、LOCAL_SYSTEM アカウントではなくインストール時に作成された ddagentuser アカウントで実行します。ライブプロセスコンポーネントは、有効になっている場合、LOCAL_SYSTEM アカウントで実行します。Datadog Windows Agent ユーザーの詳細については、こちらを参照してください。

Datadog Agent をドメイン環境にインストールするには、Agent のインストール要件を参照してください。

: ドメインコントローラーについて特別な考慮事項があります。

  1. Datadog Agent インストーラーをダウンロードします。
  2. datadog-agent-7-latest.amd64.msi を開き、インストーラーを (管理者として) 実行します。
  3. プロンプトに従ってライセンス契約に同意し、Datadog API キーを入力します。
  4. インストールが終了したら、オプションから Datadog Agent Manager を起動できます。

コマンドラインを使用して Agent をインストールするには

  1. Datadog Agent インストーラーをダウンロードします。
  2. インストーラをダウンロードしたディレクトリで、以下のコマンドのいずれかを実行します。

コマンドプロンプト

start /wait msiexec /qn /i datadog-agent-7-latest.amd64.msi APIKEY="<YOUR_DATADOG_API_KEY>"

Powershell

Start-Process -Wait msiexec -ArgumentList '/qn /i datadog-agent-7-latest.amd64.msi APIKEY="<DATADOG_API_キー>"'

  • /qn オプションはバックグラウンドインストールを実行します。GUI プロンプトを表示する場合は、削除してください。
  • Agent のバージョンによっては、強制的に再起動する場合があります。これを防ぐには、パラメーター REBOOT=ReallySuppress を追加します。

コンフィギュレーション

各構成項目は、コマンドラインにプロパティとして追加します。Agent を Windows にインストールする場合は、以下の構成コマンドラインオプションを使用できます。

変数タイプ説明
APIKEY文字列Datadog API キーを構成ファイルに追加します。
SITE文字列たとえば、SITE=datadoghq.eu のように、Datadog の取り込みサイトを設定します。
TAGS文字列構成ファイル内で割り当てるタグのカンマ区切りリスト。例: TAGS="key_1:val_1,key_2:val_2"
HOSTNAME文字列Agent から Datadog に報告されるホスト名を設定します (実行時に計算されたホスト名を上書きします)。
LOGS_ENABLED文字列構成ファイルで、ログ収集機能を有効 ("true") または無効 ("false") にします。デフォルトでは、ログは無効です。
APM_ENABLED文字列構成ファイルで、APM Agent を有効 ("true") または無効 ("false") にします。デフォルトでは、APM は有効です。
PROCESS_ENABLED文字列構成ファイルで、Process Agent を有効 ("true") または無効 ("false") にします。デフォルトでは、Process Agent は無効です。
HOSTNAME_FQDN_ENABLED文字列Agent のホスト名に対する FQDN の使用を有効 ("true") または無効 ("false") にします。これは、Agent コンフィギュレーションファイルの hostname_fqdn を設定することと同等です。ホスト名の FQDN の使用は、デフォルトでは無効になっています。(v6.20.0+)
CMD_PORT数値0 から 65534 までの有効なポート番号。Datadog Agent はコマンド API をポート 5001 で公開します。このポートが既に別のプログラムで使用されている場合は、この変数でデフォルトを上書きできます。
PROXY_HOST文字列プロキシを使っている場合は、プロキシホストを設定します。[Datadog Agent でのプロキシの使用についてさらに詳しく][7]。
PROXY_PORT数値プロキシを使っている場合は、プロキシポートを設定します。[Datadog Agent でのプロキシの使用についてさらに詳しく][7]。
PROXY_USER文字列プロキシを使っている場合は、プロキシユーザーを設定します。[Datadog Agent でのプロキシの使用についてさらに詳しく][7]。
PROXY_PASSWORD文字列プロキシを使っている場合は、プロキシパスワードを設定します。プロセス/コンテナ Agent の場合は、認証パスワードの受け渡しのためにこの変数は必須で、名前を変えることはできません。[Datadog Agent でのプロキシの使用についてさらに詳しく][7]。
DDAGENTUSER_NAME文字列Agent インストール時に使用されるデフォルトの ddagentuser ユーザー名を上書きします _(v6.11.0 以降)_。Datadog Windows Agent ユーザーについては、こちらを参照してください
DDAGENTUSER_PASSWORD文字列Agent インストール時に ddagentuser ユーザー用に生成された、暗号論的に安全なパスワードを上書きします _(v6.11.0 以降)_。ドメインサーバーへのインストールではこれを提供する必要があります。Datadog Windows Agent ユーザーについては、こちらを参照してください
APPLICATIONDATADIRECTORYパス構成ファイルのディレクトリツリーに使用するディレクトリを上書きします。初期インストール時にのみ提供でき、アップグレードでは無効です。デフォルト: C:\ProgramData\Datadog (v6.11.0 以降)
PROJECTLOCATIONパスバイナリファイルのディレクトリツリーに使用するディレクトリを上書きします。初期インストール時にのみ提供でき、アップグレードでは無効です。デフォルト: %PROGRAMFILES%\Datadog\Datadog Agent. (v6.11.0+)

: 有効な datadog.yaml が見つかり、API キーが設定されている場合は、そのファイルが、指定されているすべてのコマンドラインオプションより優先されます。

Agent 7 は Python 3 のみをサポートします。アップグレードする前に、カスタムチェックが Python 3 と互換性があることを確認します。詳細については、Python 3 カスタムチェックの移行ガイドを参照してください。カスタムチェックを使用していないか、既に互換性を確認している場合は、GUI またはコマンドラインの手順を使用してアップグレードします。

< 5.12.0 の Datadog Agent バージョンからアップグレードする場合は、最初に EXE インストーラーを使用して Agent 5 のより新しいバージョン(>= 5.12.0 だが < 6.0.0)にアップグレードしてから、 Datadog Agent バージョン >= 6 にアップグレードします。

インストールログファイル

Agent のインストールログファイルは %TEMP%\MSI*.LOG にあります。

検証

インストールを確認するには、Agent のステータスと情報 セクションの手順に従ってください。

Agent のコマンド

Agent の実行は、Windows サービスコントロールマネージャーによって制御されます。

  • メインの実行可能ファイルは agent.exe です。場所は以下の通り、Agent のバージョンにより異なります。
    • Agent バージョン 6.11 以前: "C:\Program Files\Datadog\Datadog Agent\embedded\agent.exe"
    • Agent バージョン 6.12 以降: "C:\Program Files\Datadog\Datadog Agent\bin\agent.exe"
  • 構成 GUI は、ブラウザベースの構成アプリケーションです (Windows 64 ビット版のみ)。
  • コマンドは管理者特権 (管理者として実行)のコマンドライン (PowerShell またはコマンドプロンプト) から、構文 <PATH_TO_AGENT.EXE> <COMMAND> を使用して実行できます。
  • コマンドラインのオプションは次の通りです。
コマンド説明
check指定されたチェックを実行します。
diagnoseシステムに対して接続診断を実行します。
flareフレアを収集して Datadog に送信します。
helpコマンドのヘルプを表示します。
hostnameAgent が使用するホスト名を出力します。
import以前のバージョンの Agent から構成ファイルをインポートして変換します。
installserviceサービスコントロールマネージャー内で Agent をインストールします。
launch-guiDatadog Agent Manager を起動します。
regimportレジストリ設定を datadog.yaml にインポートします。
remove-serviceサービスコントロールマネージャーから Agent を削除します。
restart-serviceサービスコントロールマネージャー内で Agent を再起動します。
runAgent を起動します。
startAgent を起動します。(非推奨ですが、受け付けられます。代わりに run を使用してください。)
start-serviceサービスコントロールマネージャー内で Agent を起動します。
status現在のステータスを出力します。
stopserviceサービスコントロールマネージャー内で Agent を停止します。
versionバージョン情報を出力します。
  • 例:

    • PowerShell (powershell.exe)

      & "$env:ProgramFiles\Datadog\Datadog Agent\bin\agent.exe" status
      & "$env:ProgramFiles\Datadog\Datadog Agent\bin\agent.exe" launch-gui
      & "$env:ProgramFiles\Datadog\Datadog Agent\bin\agent.exe" flare
    • コマンドプロンプト (cmd.exe)

      "%PROGRAMFILES%\Datadog\Datadog Agent\bin\agent.exe" status
      "%PROGRAMFILES%\Datadog\Datadog Agent\bin\agent.exe" launch-gui
      "%PROGRAMFILES%\Datadog\Datadog Agent\bin\agent.exe" flare

(スタートメニューにある) Datadog Agent Manager を使用します。

Datadog Agent Manager で startstop、および restart コマンドを使用します。

Windows Powershell で、次のコマンドを使用することもできます。 [start|stop|restart]-service datadogagent

コンフィギュレーション

Datadog Agent Manager を使ってチェックを有効化、無効化、および構成します。Agent を再起動して変更内容を適用します。

メインの Agent 構成ファイルの場所: C:\ProgramData\Datadog\datadog.yaml

メインの Agent 構成ファイルの場所: C:\ProgramData\Datadog\datadog.conf

インテグレーション用構成ファイルの場所: C:\ProgramData\Datadog\conf.d\ または C:\Documents and Settings\All Users\Application Data\Datadog\conf.d\

: ProgramData は隠しフォルダーです。

トラブルシューティング

Agent のステータスと情報

Agent が実行されていることを確認するには、サービスパネルで DatadogAgent サービスが “Started” になっているかどうかをチェックします。また、Datadog Metrics Agent (agent.exe) というプロセスがタスクマネージャーに存在している必要があります。

Agent の状態に関する詳細な情報が必要な場合は、次のようにして Datadog Agent Manager を起動します。

  • Datadog Agent のシステムトレイアイコンを右クリックし、”構成” を選択します。
  • 管理者特権 (管理者として実行)のコマンドラインから launch-gui コマンドを実行
    • PowerShell: & "<PATH_TO_AGENT.EXE>" launch-gui
    • cmd: "<PATH_TO_AGENT.EXE>" launch-gui

次に、Status -> General と移動して、ステータスページを開きます。 Status -> Collector および Checks -> Summary で、チェックの実行に関する詳細な情報を取得します。

Powershell では、次の status コマンドを使用できます。

& "$env:ProgramFiles\Datadog\Datadog Agent\bin\agent.exe" status

cmd.exe では、次のようにします。

"%PROGRAMFILES%\Datadog\Datadog Agent\bin\agent.exe" status

Agent が実行されていることを確認するには、サービスパネルでサービスのステータスが “Started” になっているかどうかをチェックします。また、ddagent.exe というプロセスがタスクマネージャーに存在している必要があります。

Agent v5.2+ では、Agent の状態に関する情報は、 Datadog Agent Manager -> Settings -> Agent Status で確認できます。

Agent v3.9.1 ~ v5.1 のステータスを確認する場合は、http://localhost:17125/status に移動します。

Powershell では、次の info コマンドを使用できます。

& "$env:ProgramFiles\Datadog\Datadog Agent\embedded<PYTHON_MAJOR_VERSION>\python.exe" "$env:ProgramFiles\Datadog\Datadog Agent\agent\agent.py" info

cmd.exe では、次のようにします。

"%PROGRAMFILES%\Datadog\Datadog Agent\embedded<PYTHON メジャーバージョン>\python.exe" "%PROGRAMFILES%\Datadog\Datadog Agent\agent\agent.py" info

: Agent バージョンが <= 6.11 の場合、パスは上記ではなく %PROGRAMFILES%\Datadog\Datadog Agent\embedded\python.exe にする必要があります。

ログの場所

Agent のログは C:\ProgramData\Datadog\logs\agent.log にあります。

: ProgramData は隠しフォルダーです。

ご不明な点は、Datadog のサポートチームまでお問合せください。

Windows Server 2008/Vista 以降のシステムでは、Agent のログは C:\ProgramData\Datadog\logs にあります。

: ProgramData は隠しフォルダーです。

ご不明な点は、Datadog のサポートチームまでお問合せください。

フレアの送信

  • http://127.0.0.1:5002 に移動して Datadog Agent Manager を表示します。

  • Flare タブを選択します。

  • チケット番号を入力します (お持ちの場合)。

  • Datadog へのログインに使用するメールアドレスを入力します。

  • Submit を押します。

Powershell では、次の flare コマンドを使用できます。

& "$env:ProgramFiles\Datadog\Datadog Agent\bin\agent.exe" flare <CASE_ID>

cmd.exe では、次のようにします。

"%PROGRAMFILES%\Datadog\Datadog Agent\bin\agent.exe" flare <CASE_ID>

Datadog のサポートチームに Windows のログと構成のコピーを送信するには、次の手順に従います。

  • Datadog Agent Manager を開きます。

  • Actions を選択します。

  • Flare を選択します。

  • チケット番号を入力します (お持ちでない場合は、値をゼロのままにしてください)。

  • Datadog へのログインに使用するメールアドレスを入力します。

Powershell では、次の flare コマンドを使用できます。

& "$env:ProgramFiles\Datadog\Datadog Agent\embedded\python.exe" "$env:Programfiles\Datadog\Datadog Agent\agent\agent.py" flare <CASE_ID>

cmd.exe では、次のようにします。

"%PROGRAMFILES%\Datadog\Datadog Agent\embedded\python.exe" "%PROGRAMFILES%\Datadog\Datadog Agent\agent\agent.py" flare <ケース ID>

フレアのアップロードの失敗

flare コマンドの出力で、圧縮されたフレアアーカイブが保存されているディレクトリがわかります。Datadog へのファイルアップロードに失敗した場合は、このディレクトリからファイルを取得して、メールの添付ファイルとして手動で追加することができます。フレアファイルの保存場所 (共通) : - Linux: \tmp\ - MacOS: $TMPDIR - Windows: C:\Users\<DDAGENTUSER>\AppData\Local\Temp\

Windows で古いバージョンの Agent を使用している場合、このファイルの場所を見つけるには、Agent の Python コマンドプロンプトから以下を実行します。

ステップ 1:

  • Agent v5.12+ の場合: "%PROGRAMFILES%\Datadog\Datadog Agent\dist\shell.exe" since

  • 古いバージョンの Agent の場合: "%PROGRAMFILES%\Datadog\Datadog Agent\files\shell.exe"

ステップ 2:

import tempfile
print tempfile.gettempdir()

例:

使用例

Windows サービスの監視

ターゲットホスト上で Datadog Agent Manager を起動し、リストから “Windows Service” インテグレーションを選択します。すぐに使用できるサンプルもありますが、この例では DHCP を使用します。

サービスの名前を確認するために、services.msc を開き、目的のサービスを見つけます。ターゲットとして DHCP を選択すると、次のように、サービスのプロパティウィンドウの上部にサービス名が表示されます。

独自のサービスを追加する場合は、次に示す書式に厳密に従ってください。書式が正しくないと、インテグレーションが失敗します。

また、インテグレーションを変更するたびに、Datadog サービスを再起動する必要があります。これは、services.msc または UI のサイドバーから行うことができます。

サービスの場合、Datadog が追跡するのはアベイラビリティのみで、メトリクスは追跡されません (メトリクスについては、プロセスまたは WMI インテグレーションを使います)。モニターをセットアップするには、インテグレーションモニタータイプを選択し、続いて Windows Service を検索します。Integration Status -> Pick Monitor Scope から、モニターしたいサービスを選びます。

Windows のシステム負荷の監視

Datadog Agent は、特に設定を行わなくても、多数のシステムメトリクスを収集できます。よく使用されるシステムメトリクスの 1 つに system.load.* があります。

メトリクス説明
system.load.1 (gauge)1 分間の平均システム負荷。
system.load.15 (gauge)15 分間の平均システム負荷。
system.load.5 (gauge)5 分間の平均システム負荷。
system.load.norm.1 (gauge)CPU 数で正規化した 1 分間の平均システム負荷。
system.load.norm.15 (gauge)CPU 数で正規化した 15 分間の平均システム負荷。
system.load.norm.5 (gauge)CPU 数で正規化した 5 分間の平均システム負荷。

system.load.*Unix 固有のメトリクスです。これは、CPU の使用を待機しているか、現在 CPU を使用しているリソースの平均量を示します。CPU の使用を待機中または CPU を使用中のプロセス 1 つあたり、負荷数が 1 増加します。メトリクス名の最後の数字は、そのメトリクスが過去 X 分間におけるそのようなプロセスの平均数であることを示します。たとえば、system.load.5 は、過去 5 分間の平均です。値 0 は CPU が完全にアイドル状態であることを示し、環境内の CPU コア数と等しい数値は、CPU が受け取ったすべてのリクエストを遅延なく処理できることを示します。これより大きい数値は、CPU の使用を待機しているプロセスがあることを意味します。

Windows のシステム負荷がどこにあるかを知るには

Windows は、そのようなメトリクス自体は提供していませんが、同等のオプションとしてシステムメトリクス system.proc.queue.length をデフォルトで使用できます。system.proc.queue.length メトリクスを使用すると、プロセッサーレディキューで遅延が確認され、実行を待機しているスレッドの数を確認できます。

Windows プロセスの監視

ライブプロセスモニタリングで Windows プロセスをモニターすることができます。これを Windows で有効にするには、次のパラメーターを真に設定することで Agent のメイン構成ファイルを編集します:

datadog.yaml:

process_config:
  enabled: "true"

構成が完了したら、Agent を再起動します。

その他の参考資料