Docker、containerd、Podman に対応した Docker Agent

概要

Datadog Docker Agent は、ホスト Agent をコンテナ化したバージョンです。Docker Agent は、Docker、containerd、Podman のランタイムをサポートしています。公式の Docker イメージは Docker Hub、GCR 、および ECR-Public からご利用いただけます。

Docker Hub にはイメージのプルレート制限があります。Docker Hub をご利用でない場合は、Datadog Agent および Cluster Agent の構成を更新して、GCR または ECR からプルすることをお勧めします。手順については、コンテナレジストリの変更を参照してください。

64-bit x86 および Arm v8 アーキテクチャ用のイメージをご用意しています。

ECR-PublicGCRDocker Hub
Agent v6+
docker pull public.ecr.aws/datadog/agent
Agent v6+
docker pull gcr.io/datadoghq/agent
Agent v6+
docker pull datadog/agent
Agent v5
docker pull public.ecr.aws/datadog/docker-dd-agent
Agent v5
docker pull gcr.io/datadoghq/docker-dd-agent
Agent v5
docker pull datadog/docker-dd-agent

このページの CLI コマンドは Docker ランタイム用です。containerd ランタイムは dockernerdctl に、Podman ランタイムは podman に置き換えてください。

セットアップ

Docker Agent をまだインストールしていない場合は、以下の手順またはアプリ内のインストール手順を参照してください。サポートされるバージョンについては、Agent のドキュメントを参照してください。ワンステップインストールコマンドを使用し、<YOUR_DATADOG_API_KEY>Datadog API キーに、<DATADOG_SITE> に置き換えてください。

docker run -d --cgroupns host --pid host --name dd-agent -v /var/run/docker.sock:/var/run/docker.sock:ro -v /proc/:/host/proc/:ro -v /sys/fs/cgroup/:/host/sys/fs/cgroup:ro -e DD_SITE=<DATADOG_SITE> -e DD_API_KEY=<DATADOG_API_KEY> gcr.io/datadoghq/agent:7

ECR-Public の場合:

docker run -d --cgroupns host --pid host --name dd-agent -v /var/run/docker.sock:/var/run/docker.sock:ro -v /proc/:/host/proc/:ro -v /sys/fs/cgroup/:/host/sys/fs/cgroup:ro -e DD_SITE=<DATADOG_SITE> -e DD_API_KEY=<DATADOG_API_KEY> public.ecr.aws/datadog/agent:7

: GCR または ECR-Public 以外の別のレジストリを使用している場合は、必ずイメージを更新してください。

: ネットワークモニタリング、セキュリティエージェント、oom_kill チェックなど system-probe が提供するいくつかの機能では、 /etc/os-release ファイルを -v /etc/os-release:/host/etc/os-release:ro でマウントする必要があります。Linux ディストリビューションに /etc/os-release ファイルがない場合は、 /etc/redhat-release/etc/fedora-release などの同等のファイルをマウントしてください。

Amazon Linux < v2 の場合:

docker run -d --name dd-agent -v /var/run/docker.sock:/var/run/docker.sock:ro -v /proc/:/host/proc/:ro -v /cgroup/:/host/sys/fs/cgroup:ro -e DD_SITE=<DATADOG_SITE> -e DD_API_KEY=<DATADOG_API_KEY> gcr.io/datadoghq/agent:7

ECR-Public の場合:

docker run -d --cgroupns host --pid host --name dd-agent -v /var/run/docker.sock:/var/run/docker.sock:ro -v /proc/:/host/proc/:ro -v /cgroup/:/host/sys/fs/cgroup:ro -e DD_SITE=<DATADOG_SITE> -e DD_API_KEY=<DATADOG_API_KEY> public.ecr.aws/datadog/agent:7

Amazon Linux v2 の場合:

docker run -d --cgroupns host --pid host --name dd-agent -v /var/run/docker.sock:/var/run/docker.sock:ro -v /proc/:/host/proc/:ro -v /sys/fs/cgroup/:/host/sys/fs/cgroup:ro -e DD_SITE=<DATADOG_SITE> -e DD_API_KEY=<DATADOG_API_KEY> gcr.io/datadoghq/agent:7

ECR-Public の場合:

docker run -d --cgroupns host --pid host --name dd-agent -v /var/run/docker.sock:/var/run/docker.sock:ro -v /proc/:/host/proc/:ro -v /sys/fs/cgroup/:/host/sys/fs/cgroup:ro -e DD_SITE=<DATADOG_SITE> -e DD_API_KEY=<DATADOG_API_KEY> public.ecr.aws/datadog/agent:7

Datadog Agent は、Windows Server 2019 (LTSC) と Windows Server 2022 (LTSC) でサポートされています。

docker run -d --name dd-agent -e DD_SITE=<DATADOG_SITE> -e DD_API_KEY=<API_KEY> -v \\.\pipe\docker_engine:\\.\pipe\docker_engine gcr.io/datadoghq/agent

ECR-Public の場合:

docker run -d --name dd-agent -e DD_SITE=<DATADOG_SITE> -e DD_API_KEY=<API_KEY> -v \\.\pipe\docker_engine:\\.\pipe\docker_engine public.ecr.aws/datadog/agent

(オプション) 非特権インストールを実行するには、インストールコマンドに --group-add=<DOCKER_GROUP_ID> を追加します。次に例を示します。

docker run -d --name dd-agent -v /var/run/docker.sock:/var/run/docker.sock:ro -v /proc/:/host/proc/:ro -v /sys/fs/cgroup/:/host/sys/fs/cgroup:ro -e DD_SITE=<DATADOG_SITE> -e DD_API_KEY=<DATADOG_API_KEY> gcr.io/datadoghq/agent:7 --group-add=<DOCKER_GROUP_ID>

ECR-Public の場合:

docker run -d --name dd-agent -v /var/run/docker.sock:/var/run/docker.sock:ro -v /proc/:/host/proc/:ro -v /sys/fs/cgroup/:/host/sys/fs/cgroup:ro -e DD_SITE=<DATADOG_SITE> -e DD_API_KEY=<DATADOG_API_KEY> public.ecr.aws/datadog/agent:7 --group-add=<DOCKER_GROUP_ID>

: Docker Compose については、Compose と Datadog Agent を参照してください。

インテグレーション

クラスター内で Agent を起動し、実行したら、Datadog のオートディスカバリー機能を使ってアプリケーションコンテナからメトリクスとログを自動的に収集します。

環境変数

Agent の メインコンフィギュレーションファイルdatadog.yaml です。Docker Agent の場合、datadog.yaml コンフィギュレーションオプションは環境変数で渡されます。

グローバルオプション

環境変数説明
DD_API_KEYDatadog API キー (必須)
DD_ENV出力されるすべてのデータにグローバル env タグを設定します。
DD_HOSTNAMEメトリクスに使用するホスト名 (自動検出が失敗した場合)
DD_HOSTNAME_FILE環境によっては、ホスト名の自動検出がうまくいかず、環境変数で値を設定できない場合があります。このような場合、ホスト上のファイルを使って適切な値を提供することができます。もし DD_HOSTNAME が空でない値に設定されている場合、このオプションは無視されます。
DD_TAGSスペース区切りのホストタグ。例: key1:value1 key2:value2
DD_SITEメトリクス、トレース、ログの送信先サイト。Datadog サイトを に設定します。デフォルトは datadoghq.com です。
DD_DD_URLメトリクス送信用 URL を上書きします。設定は任意です。
DD_URL (6.36+/7.36+)DD_DD_URL のエイリアス。すでに DD_DD_URL が設定されている場合は無視されます。
DD_CHECK_RUNNERSAgent はデフォルトですべてのチェックを同時に実行します (デフォルト値は 4 ランナーです)。チェックを順次実行する場合は、値を 1 に設定してください。ただし、多数のチェック (または時間のかかるチェック) を実行する必要がある場合、collector-queue コンポーネントが遅延して、ヘルスチェックに失敗する可能性があります。ランナーの数を増やすと、チェックを並行して実行できます。
DD_APM_ENABLEDEnables trace collection. Defaults to true. For more information about additional trace collection environment variables, see Tracing Docker Applications.
DD_LOGS_CONFIG_EXPECTED_TAGS_DURATION環境によっては、ホストからの最初のログに正しいタグが含まれないことがあります。新しいホストのタグがログに含まれていない場合は、この環境変数を含めて "10m" に設定してください。

プロキシ設定

Agent v6.4.0 (トレース Agent の場合は v6.5.0) より、以下の環境変数を使用して Agent のプロキシ設定を上書きできるようになりました。

環境変数説明
DD_PROXY_HTTPhttp リクエスト用のプロキシとして使用する HTTP URL です。
DD_PROXY_HTTPShttps リクエスト用のプロキシとして使用する HTTPS URL です。
DD_PROXY_NO_PROXYプロキシを使用すべきではない場合に必要となる、URL をスペースで区切ったリストです。

プロキシ設定の詳細については、Agent v6 プロキシのドキュメントを参照してください。

オプションの収集 Agent

セキュリティまたはパフォーマンス上の理由により、オプションの収集 Agent はデフォルトで無効になっています。このエージェントを有効にするには、以下の環境変数を使用します。

環境変数説明
DD_APM_NON_LOCAL_TRAFFIC他のコンテナからのトレース時に非ローカルなトラフィックを許可します。
DD_LOGS_ENABLEDログ Agent によるログの収集を有効にします。
DD_PROCESS_CONFIG_PROCESS_COLLECTION_ENABLEDEnable live process collection with the Process Agent. The live container view is already enabled by default if the Docker socket is available.

DogStatsD (カスタムメトリクス)

カスタムメトリクスを StatsD プロトコルで送信します。

環境変数説明
DD_DOGSTATSD_NON_LOCAL_TRAFFIC他のコンテナからの DogStatsD パケットをリスニングします (カスタムメトリクスの送信に必要)。
DD_HISTOGRAM_PERCENTILES計算するヒストグラムのパーセンタイル (スペース区切り)。デフォルトは 0.95 です。
DD_HISTOGRAM_AGGREGATES計算するヒストグラムの集計 (スペース区切り)。デフォルトは “max median avg count” です。
DD_DOGSTATSD_SOCKETリスニングする UNIX ソケットのパス。rw でマウントされたボリューム内にある必要があります。
DD_DOGSTATSD_ORIGIN_DETECTIONUNIX ソケットのメトリクス用にコンテナの検出とタグ付けを有効にします。
DD_DOGSTATSD_TAGSこの DogStatsD サーバーが受信するすべてのメトリクス、イベント、サービスのチェックに付加する追加タグ。たとえば "env:golden group:retrievers" のように追加します。
DD_USE_DOGSTATSDDogStatsD ライブラリからのカスタムメトリクスの送信を有効または無効にします。
詳しくは、Unix ドメインソケット上の DogStatsD を参照してください。

タグ付け

ベストプラクティスとして、Datadog はタグを割り当てるときに統合サービスタグ付けを使用することをお勧めします。

Datadog は Docker、Kubernetes、ECS、Swarm、Mesos、Nomad、Rancher から一般的なタグを自動的に収集します。さらに多くのタグを抽出するには、次のオプションを使用します。

環境変数説明
DD_CONTAINER_LABELS_AS_TAGSコンテナラベルを抽出します。この環境は、古い DD_DOCKER_LABELS_AS_TAGS 環境と同等です。
DD_CONTAINER_ENV_AS_TAGSコンテナ環境変数を抽出します。この環境は、古い DD_DOCKER_ENV_AS_TAGS 環境と同等です。
DD_COLLECT_EC2_TAGSAWS インテグレーションを使用せずに、カスタム EC2 タグを抽出します。

詳細については、Docker タグの抽出ドキュメントを参照してください。

シークレットファイルの使用

インテグレーションの資格情報を Docker や Kubernetes のシークレットに格納し、オートディスカバリーテンプレートで使用できます。詳細については、シークレット管理のドキュメントを参照してください。

コンテナの無視

ログの収集、メトリクスの収集、オートディスカバリーからコンテナを除外します。Datadog はデフォルトで Kubernetes と OpenShift の pause コンテナを除外します。これらの許可リストとブロックリストはオートディスカバリーにのみ適用されます。トレースと DogStatsD は影響を受けません。これらの環境変数の値は、正規表現をサポートしています。

環境変数説明
DD_CONTAINER_INCLUDE処理対象に入れるコンテナの許可リスト (スペース区切り)。すべてを対象に入れる場合は、.* を使用します。例: "image:image_name_1 image:image_name_2"image:.* OpenShift 環境内で ImageStreams を使用する場合は、イメージの代わりにコンテナ名を使用してください。例: “name:container_name_1 name:container_name_2”, name:.*
DD_CONTAINER_EXCLUDE処理対象から除外するコンテナのブロックリスト (スペース区切り)。すべてを対象から除外する場合は、.* を使用します。例: "image:image_name_3 image:image_name_4" (: この変数はオートディスカバリーに対してのみ有効)、image:.*
DD_CONTAINER_INCLUDE_METRICSメトリクスを含めたいコンテナの許可リスト。
DD_CONTAINER_EXCLUDE_METRICSメトリクスを除外したいコンテナのブロックリスト。
DD_CONTAINER_INCLUDE_LOGSログを含めたいコンテナの許可リスト。
DD_CONTAINER_EXCLUDE_LOGSログを除外したいコンテナのブロックリスト。
DD_AC_INCLUDE非推奨: 処理対象に入れるコンテナの許可リスト (スペース区切り)。すべてを対象に入れる場合は、.* を使用します。例: "image:image_name_1 image:image_name_2"image:.*
DD_AC_EXCLUDE非推奨: 処理対象から除外するコンテナのブロックリスト (スペース区切り)。すべてを対象から除外する場合は、.* を使用します。例: "image:image_name_3 image:image_name_4" (: この変数はオートディスカバリーに対してのみ有効)、image:.*

その他の例はコンテナのディスカバリー管理ページでご確認いただけます。

: kubernetes.containers.runningkubernetes.pods.runningdocker.containers.running.stopped.running.total.stopped.total の各メトリクスは、この設定の影響を受けません。すべてのコンテナを対象とします。なお、これらはコンテナの課金に影響しません。

: containerd を使用する場合、DD_CONTAINERD_NAMESPACESDD_CONTAINERD_EXCLUDE_NAMESPACES を使用すると、ネームスペースでコンテナを無視することが可能です。どちらもスペースで区切られたネームスペースのリストです。DD_CONTAINERD_NAMESPACES が設定されている場合、Agent はリストに存在するネームスペースに属するコンテナのデータを報告します。DD_CONTAINERD_EXCLUDE_NAMESPACES が設定されている場合、Agent はリストのネームスペースに属するものを除く、すべてのコンテナのデータをレポートします。

オートディスカバリー

環境変数説明
DD_LISTENERS実行するオートディスカバリーリスナー。
DD_EXTRA_LISTENERS実行するオートディスカバリーリスナーを追加します。これは datadog.yaml コンフィギュレーションファイルの listeners セクションで定義された変数に加えて追加されます。
DD_CONFIG_PROVIDERSAgent がチェック構成を収集するために呼び出すべきプロバイダー。デフォルトのプロバイダーは docker です。Docker プロバイダーはコンテナラベルに埋め込まれたテンプレートを処理します。
DD_EXTRA_CONFIG_PROVIDERS使用するオートディスカバリー構成プロバイダーを追加します。これは datadog.yaml コンフィギュレーションファイルの config_providers セクションで定義された変数に加えて追加されます。

その他

環境変数説明
DD_PROCESS_AGENT_CONTAINER_SOURCEコンテナソースの自動検出を上書きして、1 つのソースに制限します ("docker""ecs_fargate""kubelet" など)。Agent v7.35.0 以降、不要になりました。
DD_HEALTH_PORTこれを 5555 に設定すると、Agent のヘルスチェックをポート 5555 で公開します。

コマンド

すべての Docker Agent コマンドは Agent コマンドガイドでご確認いただけます。

データ収集

メトリクス

デフォルトで、Docker Agent はメトリクスを以下の主要なチェックのために収集します。他のテクノロジーからメトリクスを収集するには、インテグレーションのセクションを参照してください。

チェックメトリクス
コンテナMetrics
CPUSystem
ディスクDisk
DockerDocker
ファイル処理System
IOSystem
ロードSystem
メモリSystem
ネットワークNetwork
NTPNTP
アップタイムSystem

イベント

Agent の起動または再起動の際に、Docker Agent はイベントを Datadog に送信します。

サービスチェック

datadog.agent.up:
Agent が Datadog に接続できない場合は、CRITICAL を返します。それ以外の場合は、OK を返します。

datadog.agent.check_status:
Agent チェックが Datadog にメトリクスを送信できない場合は、CRITICAL を返します。それ以外の場合は、OK を返します。

Uninstall Single Step APM Instrumentation

If you installed the Datadog Docker Agent with Single Step APM Instrumentation, and you want to uninstall the Agent, you need to run additional commands to uninstall APM Instrumentation.

その他の参考資料

PREVIEWING: may/unit-testing