Docker とインテグレーション

Docs > コンテナモニタリング > Docker、containerd、Podman に対応した Docker Agent > Docker とインテグレーション

このページでは、Datadog の Autodiscovery 機能を使用して Docker インフラストラクチャのインテグレーションをインストールおよび構成する方法を説明しています。Autodiscovery を使用すると、%%host%% のような変数を利用して設定を動的に入力できます。

Autodiscovery がどのように機能するかの詳細な説明は、コンテナー入門: Autodiscovery を参照してください。特定のコンテナを Autodiscovery から除外したり、未準備の pod を許容したりするなどの高度な Autodiscovery オプションについては、コンテナディスカバリー管理を参照してください。

Kubernetes を使用している場合は、Kubernetes とインテグレーションを参照してください。

Autodiscovery ではプロセスツリーデータまたはファイルシステムへのアクセスが必要になるため、Ceph、Varnish、Postfix、Cassandra Nodetool、および Gunicorn の Datadog インテグレーションは動作しません。

Autodiscovery に対応していないインテグレーションを監視するには、pod 内に Prometheus エクスポーターを配置して HTTP エンドポイントを公開し、その後 Autodiscovery をサポートする OpenMetrics インテグレーションを使用して pod を検出し、エンドポイントをクエリします。

インテグレーションをセットアップする

一部のインテグレーションでは、アクセストークンを作成するあるいは Datadog Agent に読み取り権限を付与するなど、セットアップ手順が必要です。詳細は、インテグレーションのドキュメントの Setup セクションの手順に従ってください。

Community インテグレーション

Datadog Agent に同梱されていないインテグレーションを使用する場合は、目的のインテグレーションを含むカスタムイメージをビルドする必要があります。手順については Community インテグレーションの使用を参照してください。

設定

よく使用されるインテグレーションの中には、Autodiscovery 用のデフォルト設定が同梱されているものがあります。自動設定されているインテグレーション一覧と、それぞれのデフォルト設定ファイルについては Autodiscovery 自動設定を参照してください。ご使用のインテグレーションがこの一覧に含まれ、そのデフォルト設定が要件を満たす場合、追加の操作は不要です。

それ以外の場合:

ユースケースに適した設定方法 (Docker ラベル、ローカルファイル、または Key‑value ストア) を選択してください。
選択した方法のテンプレート形式を参照してください。各形式には <CONTAINER_IMAGE> のようなプレースホルダーが含まれています。
これらのプレースホルダーに値を入力してください。

Dockerfile

Datadog Agent v7.36+ の場合:

LABEL "com.datadoghq.ad.checks"='{"<INTEGRATION_NAME>": {"instances": [<INSTANCE_CONFIG>], "logs": [<LOGS_CONFIG>]}}'

旧バージョンの Agent の場合:

LABEL "com.datadoghq.ad.check_names"='[<INTEGRATION_NAME>]'
LABEL "com.datadoghq.ad.init_configs"='[<INIT_CONFIG>]'
LABEL "com.datadoghq.ad.instances"='[<INSTANCE_CONFIG>]'
LABEL "com.datadoghq.ad.logs"='[<LOGS_CONFIG>]'

docker-compose.yaml

Datadog Agent v7.36+ の場合:

labels:
  com.datadoghq.ad.checks: '{"<INTEGRATION_NAME>": {"instances": [<INSTANCE_CONFIG>], "logs": [<LOGS_CONFIG>]}}'

旧バージョンの Agent の場合:

labels:
  com.datadoghq.ad.check_names: '[<INTEGRATION_NAME>]'
  com.datadoghq.ad.init_configs: '[<INIT_CONFIG>]'
  com.datadoghq.ad.instances: '[<INSTANCE_CONFIG>]'
  com.datadoghq.ad.logs: '[<LOGS_CONFIG>]'

docker run、nerdctl run、または podman run を使用する場合

Datadog Agent v7.36+ の場合:

docker run -l com.datadoghq.ad.checks="{\"<INTEGRATION_NAME>\": {\"instances\": [<INSTANCE_CONFIG>], \"logs\": [<LOGS_CONFIG>]}}"

旧バージョンの Agent の場合:

docker run -l com.datadoghq.ad.check_names='[<INTEGRATION_NAME>]' -l com.datadoghq.ad.init_configs='[<INIT_CONFIG>]' -l com.datadoghq.ad.instances='[<INSTANCE_CONFIG>]' -l com.datadoghq.ad.logs='[<LOGS_CONFIG>]'

注: これらのラベルを設定する際に JSON をエスケープできます。例:

docker run -l "com.datadoghq.ad.checks="{\"apache\": {\"instances\": [{\"apache_status_url\":\"http://%%host%%/server-status?auto2\"}]}}"

Docker Swarm

Docker Cloud で Swarm モードを使用する場合、ラベルはイメージに適用する必要があります。

Datadog Agent v7.36 以上の場合:

version: "1.0"
services:
...
  project:
    image: '<IMAGE_NAME>'
    labels:
      com.datadoghq.ad.checks: '{"<INTEGRATION_NAME>": {"instances": [<INSTANCE_CONFIG>], "logs": [<LOGS_CONFIG>]}}'

旧バージョンの Agent の場合:

version: "1.0"
services:
...
  project:
    image: '<IMAGE_NAME>'
    labels:
      com.datadoghq.ad.check_names: '[<INTEGRATION_NAME>]'
      com.datadoghq.ad.init_configs: '[<INIT_CONFIG>]'
      com.datadoghq.ad.instances: '[<INSTANCE_CONFIG>]'
      com.datadoghq.ad.logs: '[<LOGS_CONFIG>]'

マウントされた /conf.d ディレクトリ内に Autodiscovery テンプレートをローカルファイルとして保存できます。テンプレートを変更・追加・削除するたびに Agent コンテナを再起動する必要があります。

ホスト上に conf.d/<INTEGRATION_NAME>.d/conf.yaml ファイルを作成します:

ad_identifiers:
  - <CONTAINER_IMAGE>

init_config:
  <INIT_CONFIG>

instances:
  <INSTANCES_CONFIG>

logs:
  <LOGS_CONFIG>

ホストの conf.d/ フォルダーをコンテナ化された Agent の conf.d フォルダーにマウントします。

Autodiscovery テンプレートは Consul、etcd、または ZooKeeper から取得できます。datadog.yaml 構成ファイルでキーバリューストアを設定する (その後、このファイルを Agent コンテナ内にマウントする) か、Agent コンテナ内の環境変数として設定できます。"

datadog.yaml での設定:

datadog.yaml でキーバリューストアの <KEY_VALUE_STORE_IP> アドレスと <KEY_VALUE_STORE_PORT> を設定します:

config_providers:
  - name: etcd
    polling: true
    template_dir: /datadog/check_configs
    template_url: '<KV_STORE_IP>:<KV_STORE_PORT>'
    username:
    password:

  - name: consul
    polling: true
    template_dir: datadog/check_configs
    template_url: '<KV_STORE_IP>:<KV_STORE_PORT>'
    ca_file:
    ca_path:
    cert_file:
    key_file:
    username:
    password:
    token:

  - name: zookeeper
    polling: true
    template_dir: /datadog/check_configs
    template_url: '<KV_STORE_IP>:<KV_STORE_PORT>'
    username:
    password:

Datadog Agent を再起動して変更を適用してください。

環境変数での設定:

キーバリューストアをテンプレートソースとして有効にすると、Agent は /datadog/check_configs キー配下でテンプレートを探します。Autodiscovery は次のようなキーバリュー階層を想定します:

/datadog/
  check_configs/
    <CONTAINER_IMAGE>/
      - check_names: ["<INTEGRATION_NAME>"]
      - init_configs: ["<INIT_CONFIG>"]
      - instances: ["<INSTANCES_CONFIG>"]
      - logs: ["<LOGS_CONFIG>"]
    ...

プレースホルダー値

次のようにプレースホルダーに値を入力します:

<INTEGRATION_NAME>: Datadog インテグレーションの名前。例: etcd、redisdb。
<CONTAINER_IMAGE>: コンテナイメージを識別するための ID。

たとえば redis を指定すると、redis に一致するイメージ名を持つすべてのコンテナに Autodiscovery テンプレートが適用されます。foo/redis:latest と bar/redis:v2 の 2 つのコンテナがあれば、どちらにも適用されます。

ad_identifiers パラメーターはリストを受け取るため、複数のコンテナ ID を指定できます。カスタム ID も使用可能です。詳細はカスタム Autodiscovery 識別子を参照してください。
<INIT_CONFIG>: インテグレーションの <INTEGRATION_NAME>.d/conf.yaml.example ファイルの init_config セクションに記載されている設定パラメーター。通常は空です。
<INSTANCES_CONFIG>: インテグレーションの <INTEGRATION_NAME>.d/conf.yaml.example ファイルの instances セクションに記載されている設定パラメーター。
<LOGS_CONFIG>: インテグレーションの <INTEGRATION_NAME>.d/conf.yaml.example ファイルの logs セクションに記載されている設定パラメーター。

例

Redis インテグレーション

Redis は Autodiscovery 自動設定に対応するテクノロジーの 1 つです。以下の例では、この基本設定を上書きし、password パラメーターを追加するカスタム設定を示します。

REDIS_PASSWORD という名前の環境変数にパスワードを保存した上で、次を実行します:

Datadog Agent v7.36 以上の場合:

labels:
  com.datadoghq.ad.checks: '{"redisdb": {"instances": [{"host": "%%host%%","port":"6379","password":"%%env_REDIS_PASSWORD%%"}], "logs": [{"type": "file", "path": "/var/log/redis_6379.log", "source": "redis", "service": "redis_service"}]}}'

旧バージョンの Agent の場合:

labels:
  com.datadoghq.ad.check_names: '["redisdb"]'
  com.datadoghq.ad.init_configs: '[{}]'
  com.datadoghq.ad.instances: '[{"host": "%%host%%","port":"6379","password":"%%env_REDIS_PASSWORD%%"}]'
  com.datadoghq.ad.logs: '[{"type": "file", "path": "/var/log/redis_6379.log", "source": "redis", "service": "redis_service"}]'

ホストに conf.d/redisdb.d/conf.yaml ファイルを作成します:

ad_identifiers:
  - redis
init config:
instances:
  - host: "%%host%%"
    port: "6379"
    username: "datadog"
    password: "%%env_REDIS_PASSWORD%%"
logs:
  - type: "file"
    path: "/var/log/redis.log"
    source: "redis"
    service: "redis_service"

ホストの conf.d/ フォルダーをコンテナ化された Agent の conf.d フォルダーにマウントします。

次の etcd コマンドは password パラメーターを含む Redis インテグレーションテンプレートを作成します:

etcdctl mkdir /datadog/check_configs/redis
etcdctl set /datadog/check_configs/redis/check_names '["redisdb"]'
etcdctl set /datadog/check_configs/redis/init_configs '[{}]'
etcdctl set /datadog/check_configs/redis/instances '[{"host": "%%host%%","port":"6379","password":"%%env_REDIS_PASSWORD%%"}]'

“ご覧のとおり、これら 3 つの値はすべてリストです。Autodiscovery は同じリストインデックスを基にリスト項目を組み合わせてインテグレーション設定を生成します。この例では、check_names[0]、init_configs[0]、instances[0] から最初 (かつ唯一) のチェック設定が構成されます。

これらの例ではすべて Autodiscovery テンプレート変数を使用しています:

%%host%% はコンテナの IP で動的に置き換えられます。
%%env_REDIS_PASSWORD%% は Agent プロセスから見える REDIS_PASSWORD という環境変数を参照します。

複数のコンテナセットに対して複数のチェックを設定する方法など、さらに多くの例については Autodiscovery: シナリオ & 例を参照してください。