Kubernetes 上の Datadog Agent を DaemonSet で手動でインストール、構成する

インストール

DaemonSet を利用して、すべてのノード (または nodeSelectors を使用して特定のノード) に Datadog Agent をデプロイすることができます。

Datadog Agent を Kubernetes クラスターにインストールするには:

1. Agent のアクセス許可を構成: Kubernetes で RBAC (ロールベースのアクセス制御) が有効になっている場合は、Datadog Agent サービスアカウントに対する RBAC アクセス許可を構成します。Kubernetes 1.6 以降では、RBAC はデフォルトで有効になっています。適切な ClusterRole、ServiceAccount、および ClusterRoleBinding を、以下のコマンドで作成します。

   kubectl apply -f "https://raw.githubusercontent.com/DataDog/datadog-agent/master/Dockerfiles/manifests/rbac/clusterrole.yaml"
   
   kubectl apply -f "https://raw.githubusercontent.com/DataDog/datadog-agent/master/Dockerfiles/manifests/rbac/serviceaccount.yaml"
   
   kubectl apply -f "https://raw.githubusercontent.com/DataDog/datadog-agent/master/Dockerfiles/manifests/rbac/clusterrolebinding.yaml"
   

   注: RBAC 構成は、default ネームスペースに設定されています。カスタムネームスペースを使用している場合、適用する前に namespace パラメーターを更新します。

2. Datadog Agent マニフェストを作成。以下のテンプレートを使用して、datadog-agent.yaml マニフェストを作成します。

   メトリクス	ログ	APM	プロセス	NPM	セキュリティ	Linux	Windows
   						マニフェストテンプレート	マニフェストテンプレート (セキュリティなし)
   						マニフェストテンプレート	マニフェストテンプレート
   						マニフェストテンプレート	マニフェストテンプレート
   						マニフェストテンプレート	マニフェストテンプレート
   						マニフェストテンプレート	テンプレートなし
   						マニフェストテンプレート	マニフェストテンプレート

   トレース収集を完全に有効にするには、アプリケーションのポッドコンフィギュレーションで追加の手順が必要となります。それぞれの機能を個別に有効にする方法については、ログ、APM、プロセス、ネットワークパフォーマンスモニタリング、セキュリティに関するドキュメントページを参照してください。

   注: これらのマニフェストは、default ネームスペースに設定されています。カスタムネームスペースを使用している場合、適用する前に metadata.namespace パラメーターを更新します。

3. secret-api-key.yaml マニフェストで、PUT_YOUR_BASE64_ENCODED_API_KEY_HERE を base64 でエンコードされた Datadog API キーに置き換えます。API キーの base64 バージョンを取得するには、次のコマンドを実行します。

   echo -n '<Your API key>' | base64
   

4. datadog-agent-all-features.yaml マニフェストテンプレートを使用している場合: secret-cluster-agent-token.yaml マニフェストの PUT_A_BASE64_ENCODED_RANDOM_STRING_HERE を base64 でエンコードしたランダムな文字列に置き換えてください。base64 版を取得するには、次のように実行します。

   echo -n 'Random string' | base64
   

   注: Cluster Agent 間の通信を保護するため、ランダムな文字列には少なくとも 32 文字の英数字が含まれている必要があります。

5. datadog-agent.yaml マニフェストで、DD_SITE 環境変数を使用して Datadog サイトを に設定します。

   注: DD_SITE 環境変数が明示的に設定されていない場合、値はデフォルトで US サイトの datadoghq.com に設定されます。その他のサイトのいずれかを使用している場合は、API キーのメッセージが無効になります。ドキュメントのサイト選択ドロップダウンを使用して、使用中のサイトに適したドキュメントを確認してください。

6. 次のコマンドで DaemonSet をデプロイします。

   kubectl apply -f datadog-agent.yaml
   

7. 検証: 現在の環境で Datadog Agent が DaemonSet として動作していることを検証するには、次を実行します。

   kubectl get daemonset
   

   Agent がデプロイされた場合は、以下のようなテキスト出力が表示されます。DESIRED と CURRENT はクラスター内で実行中のノードの数と等しくなります。

   NAME      DESIRED   CURRENT   READY     UP-TO-DATE   AVAILABLE   NODE SELECTOR   AGE
   datadog   2         2         2         2            2           <none>          10s
   

コンフィギュレーション

ログの収集

注: このオプションは Windows ではサポートされません。代わりに Helm オプションを使用してください。

DaemonSet によるログの収集を有効にするには

1. datadog.yaml Agent マニフェストの env セクションで、DD_LOGS_ENABLED 変数と DD_LOGS_CONFIG_CONTAINER_COLLECT_ALL 変数を true に設定します。

    # (...)
     env:
       # (...)
       - name: DD_LOGS_ENABLED
         value: "true"
       - name: DD_LOGS_CONFIG_CONTAINER_COLLECT_ALL
         value: "true"
       - name: DD_CONTAINER_EXCLUDE_LOGS
         value: "name:datadog-agent"
    # (...)
   

   注: DD_CONTAINER_EXCLUDE_LOGS を設定すると、Datadog Agent で自身のログ収集および送信が実行されなくなります。Datadog Agent ログを収集する場合は、このパラメーターを削除します。詳細については、コンテナを無視するための環境変数を参照してください。OpenShift 環境内で ImageStreams を使用する場合は、DD_CONTAINER_INCLUDE_LOGS にコンテナの name を設定してログを収集します。これらのパラメーター値 (除外/含む) は正規表現をサポートします。

2. 再起動やネットワーク障害の際にコンテナログを失わないように、pointerdir ボリュームをマウントします。/var/log/pods がこのディレクトリへのシンボリックリンクであるため、Kubernetes ログファイルからログを収集するよう /var/lib/docker/containers もマウントします。

     # (...)
       volumeMounts:
         # (...)
         - name: pointerdir
           mountPath: /opt/datadog-agent/run
         - name: logpodpath
          mountPath: /var/log/pods
         # Docker runtime directory, replace this path
         # with your container runtime logs directory,
         # or remove this configuration if `/var/log/pods`
         # is not a symlink to any other directory.
         - name: logcontainerpath
          mountPath: /var/lib/docker/containers
     # (...)
     volumes:
       # (...)
       - hostPath:
           path: /opt/datadog-agent/run
         name: pointerdir
       - hostPath:
           path: /var/log/pods
         name: logpodpath
       # Docker runtime directory, replace this path
       # with your container runtime logs directory,
       # or remove this configuration if `/var/log/pods`
       # is not a symlink to any other directory.
       - hostPath:
           path: /var/lib/docker/containers
         name: logcontainerpath
       # (...)
   

   pointerdir は、Agent がログを収集するすべてのコンテナへのポインターを含むファイルを格納するために使用されます。これは、Agent が再起動したり、ネットワークに問題があった場合でも、何も失われないようにするためです。

非特権

(オプション) 非特権インストールを実行するには、ポッドテンプレートに以下を追加します。

  spec:
    securityContext:
      runAsUser: <USER_ID>
      supplementalGroups:
        - <DOCKER_GROUP_ID>

<USER_ID> が、Agent を実行する UID で、<DOCKER_GROUP_ID> が、Docker または Containerd ソケットを所有するグループ ID の場合。

Agent が非ルートユーザーで実行しているときは、/var/lib/docker/containers に含まれるログファイルを直接読み取れません。この場合、Docker Daemon からコンテナログをフェッチできるよう、Agent コンテナの Docker ソケットをマウントする必要があります。

Cluster Agent のイベント収集

Kubernetes イベントを Datadog Cluster Agent で収集したい場合は、次の手順を使用します。

1. leader_election 変数または DD_LEADER_ELECTION 環境変数を false に設定して、Node Agent のリーダー選出を無効にします。

2. Cluster Agent デプロイファイルで、DD_COLLECT_KUBERNETES_EVENTS および DD_LEADER_ELECTION 環境変数を true に設定します。

     - name: DD_COLLECT_KUBERNETES_EVENTS
       value: "true"
     - name: DD_LEADER_ELECTION
       value: "true"
   

上記の手順でリーダー選出を構成することで、イベントを収集する Cluster Agent が 1 つだけになるようにします。

また、Node Agent から Kubernetes イベントを収集するには、Agent マニフェストで環境変数 DD_COLLECT_KUBERNETES_EVENTS と DD_LEADER_ELECTION を true に設定してください。

- name: DD_COLLECT_KUBERNETES_EVENTS
  value: "true"
- name: DD_LEADER_ELECTION
  value: "true"

環境変数

以下は、DaemonSet を使用する Datadog Agent で使用可能な環境変数のリストです。

グローバルオプション

プロキシ設定

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

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

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

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

詳しくは、Unix ドメインソケット上の DogStatsD を参照してください。

タグ付け

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

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

コンテナの無視

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

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

注: kubernetes.containers.running、kubernetes.pods.running、docker.containers.running、.stopped、.running.total、.stopped.total の各メトリクスは、この設定の影響を受けません。すべてのコンテナを対象とします。

その他

リスナーおよび構成プロバイダーを追加するには、DD_EXTRA_LISTENERS と DD_EXTRA_CONFIG_PROVIDERS の環境変数を使用します。これらは datadog.yaml 構成ファイルの listeners セクションと config_providers セクションに定義する変数に追加されます。