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

Docs > Agent > 基本的な Agent の利用方法 > Windows 用 Agent の基本的な使用方法

概要

このページでは、Windows 用 Datadog Agent の基本機能を説明します。Agent をまだインストールしていない場合は、以下のインストール手順を参照するか、アプリ内の指示に従ってください。

Datadog Agent をインストールする

要件

Windows バージョン: Windows Server 2016 以降、または Windows 10 以降。サポートされている OS バージョンについては、Agent のサポートプラットフォームドキュメントを参照してください。
Datadog アカウント: Datadog アカウントにアクセスでき、Datadog API キーを持っていることを確認してください。
管理者権限: Windows マシンで管理者権限が必要です。

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

GUI を使ってインストール

Agent のデフォルトのインストール先は %ProgramFiles%\Datadog\Datadog Agent です。カスタムのインストール先を使用する場合は、必ず Datadog ファイル用の Datadog サブディレクトリを指定してください。

Datadog Agent インストーラーをダウンロードし、最新バージョンの Agent をインストールします。
datadog-agent-7-latest.amd64.msi を開いてインストーラーを実行します。プロンプトが表示されたら、管理者資格情報を入力します。
プロンプトに従ってライセンス契約に同意し、Datadog API キーを入力します。

インストールが終了したら、オプションから Datadog Agent Manager を起動できます。

コマンドラインを使ってインストール

管理者権限で PowerShell を開きます。

Datadog Agent をインストールするには、以下のコマンドを実行します。

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

Datadog Agent を Active Directory 環境にデプロイする場合は、グループ管理サービスアカウント (gMSA) の使用を推奨します。

gMSA を使用することで、セキュリティが強化され、管理が簡素化されます。以下はその利点の一部です。

複数のサーバーへのデプロイ: 従来のマネージドサービスアカウント (MSA) やスタンドアロン型マネージドサービスアカウント (sMSA) とは異なり、gMSA は複数のサーバーにデプロイすることができます。
パスワードの自動管理: gMSA のパスワードは OS レベルで管理され、手動の介入なしに定期的に変更されます。

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

前提条件

Active Directory 環境
gMSA の作成と管理の権限
Microsoft のドキュメントに記載されている要件を参照してください。

注: gMSA のセットアップについて詳しく理解するためには、Microsoft のグループ管理サービスアカウントの概要をご覧ください。

gMSA の作成と構成

セキュリティグループを作成します。
1. Active Directory ユーザーとコンピュータ (ADUC) を開きます。
2. 適切な組織単位 (OU) に移動します。
3. 右クリックして、新規 > グループを選択します。
4. グループに名前を付けます。例えば、DatadogAgentsGroup とします。
5. 組織に正しいグループスコープを設定します。例えば、Domain local とします。
6. タイプをセキュリティに設定します。
gMSA を作成します。
1. 管理者権限で PowerShell を開きます。
2. gMSA を作成するために次のコマンドを実行し、<YOUR_DOMAIN_NAME> をドメイン名に置き換えます。
```
New-ADServiceAccount -Name DatadogGMSA -DNSHostName <YOUR_DOMAIN_NAME> -PrincipalsAllowedToRetrieveManagedPassword DatadogAgentsGroup
```
gMSA がターゲットマシンで使用できることを確認します。
1. ターゲットマシンが DatadogAgentsGroup に含まれていることを確認します。
2. ターゲットマシンで PowerShell を開き、次のコマンドを実行します。
```
Install-ADServiceAccount -Identity DatadogGMSA
```
  コマンドがエラーなしで実行されたことを確認します。

Agent のインストール

以下の手順に従って、Datadog Agent の最新バージョンをインストールします。特定のバージョンをインストールする必要がある場合は、インストーラの一覧を参照してください。

GUI 経由でインストール

Datadog Agent インストーラーをダウンロードし、最新バージョンの Agent をインストールします。
datadog-agent-7-latest.amd64.msi を開いてインストーラーを実行します。プロンプトが表示されたら、管理者資格情報を入力します。
プロンプトに従ってライセンス契約に同意し、Datadog API キーを入力します。
“Datadog Agent User Account” の入力を求められたら、gMSA のユーザー名を入力します。例えば、<YOUR_DOMAIN_NAME>\DatadogGMSA と入力し、パスワードは入力しません。 インストールが終了したら、オプションから Datadog Agent Manager を起動できます。

コマンドラインを使ってインストール

管理者権限で PowerShell を開きます。
Datadog Agent をインストールするには、以下のコマンドを実行します。

注: DatadogGMSA$ を gMSA のユーザー名に置き換えてください。ユーザー名は $ 記号で終わらなければなりません。

Start-Process -Wait msiexec -ArgumentList '/qn /i datadog-agent-7-latest.amd64.msi APIKEY="<YOUR_DATADOG_API_KEY>" DDAGENTUSER_NAME="<YOUR_DOMAIN_NAME>\DatadogGMSA$"'

インストール構成オプション

Windows に Agent をインストールする際、以下の各構成オプションをコマンドラインのプロパティとして追加することができます。その他の Agent 構成オプションについては、その他の Agent 構成オプションを参照してください。

変数	タイプ	説明
`APIKEY`	文字列	Datadog API キーを構成ファイルに追加します。
`SITE`	文字列	Datadog インテークサイトを設定します。例: `SITE=`
`TAGS`	文字列	構成ファイル内で割り当てるタグのカンマ区切りリスト。例: `TAGS="key_1:val_1,key_2:val_2"`
`HOSTNAME`	文字列	Agent から Datadog に報告されるホスト名を設定します (実行時に計算されたホスト名を上書きします)。
`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 ファイル用の `Datadog` サブディレクトリを必ず指定してください。

注

/qn オプションはバックグラウンドインストールを実行します。GUI プロンプトを表示する場合は、削除してください。
Agent のバージョンによっては、強制的に再起動する場合があります。これを防ぐには、パラメーター REBOOT=ReallySuppress を追加します。
Agent コンポーネントの中には、データを収集するためにカーネルドライバーを必要とするものがあります。お使いのコンポーネントにカーネルドライバーが必要かどうかは、そのコンポーネントのドキュメントページを参照するか、関連する Agent コンフィギュレーションファイルで kernel driver を検索してください。
有効な datadog.yaml が見つかった場合は、そのファイルが、指定されているすべてのコマンドラインオプションより優先されます。

その他の Agent 構成オプション

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

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

変数	タイプ	説明
`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 でのプロキシの使用についてさらに詳しく。
`PROXY_PORT`	数値	プロキシを使っている場合は、プロキシポートを設定します。Datadog Agent でのプロキシの使用についてさらに詳しく。
`PROXY_USER`	文字列	(プロキシを使っている場合) プロキシユーザーを設定します。Datadog Agent でのプロキシの使用についてさらに詳しく。
`PROXY_PASSWORD`	文字列	(プロキシを使っている場合) プロキシパスワードを設定します。プロセス/コンテナ Agent の場合は、認証パスワードの受け渡しのためにこの変数は必須で、名前を変えることはできません。Datadog Agent でのプロキシの使用についてさらに詳しく。
`EC2_USE_WINDOWS_PREFIX_DETECTION`	Boolean	EC2 上の Windows ホストの EC2 インスタンス ID を使用します。(v7.28.0+)
[非推奨] `ADDLOCAL`	文字列	追加の Agent コンポーネントを有効にします。`"MainApplication,NPM"` に設定すると、Cloud Network Monitoring のドライバーコンポーネントがインストールされます。(バージョン 7.44.0 以前)

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

< 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	コマンドのヘルプを表示します。
hostname	Agent が使用するホスト名を出力します。
import	以前のバージョンの Agent から構成ファイルをインポートして変換します。
launch-gui	Datadog Agent Manager を起動します。
restart-service	サービスコントロールマネージャー内で Agent を再起動します。
run	Agent を起動します。
start	Agent を起動します。(非推奨ですが、受け付けられます。代わりに `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 を使ってチェックを有効化、無効化、および構成します。Agent を再起動して変更内容を適用します。

メインの Agent コンフィギュレーションファイルの場所: C:\ProgramData\Datadog\datadog.yaml

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

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

Agent のアンインストール

Windows で Agent をアンインストールするには、2 つの異なる方法があります。どちらの方法でも Agent は削除されますが、ホスト上の C:\ProgramData\Datadog 構成フォルダは削除されません。

プログラムの追加と削除

CTRL キーと Esc キーを押すか、Windows キーで Windows Search を実行します。
add を検索し、Add or remove programs をクリックします。
Datadog Agent を検索し、Uninstall をクリックします。

PowerShell

注: 以下のコマンドを使用する場合は、WinRM を有効にしてください。

以下の PowerShell コマンドを使用して、再起動せずに Agent をアンインストールします。

$productCode = (@(Get-ChildItem -Path "HKLM:SOFTWARE\Microsoft\Windows\CurrentVersion\Uninstall" -Recurse) | Where {$_.GetValue("DisplayName") -like "Datadog Agent" }).PSChildName
start-process msiexec -Wait -ArgumentList ('/log', 'C:\uninst.log', '/q', '/x', "$productCode", 'REBOOT=ReallySuppress')

トラブルシューティング

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 のログは C:\ProgramData\Datadog\logs\agent.log にあります。

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

フレアの送信

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>

ユースケース

Windows サービスの監視

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

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

独自のサービスを追加する場合は、次に示す書式に厳密に従ってください。書式が正しくないと、インテグレーションが失敗します。注: サービス名の特殊文字はエスケープする必要があります。たとえば、MSSQL$BILLING という名前の場合、MSSQL\$BILLING のように特殊文字を追加します。

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

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