注: AD Annotations v2 は、インテグレーション構成を簡素化するために、Datadog Agent 7.36 で導入されました。Datadog Agent の以前のバージョンでは、AD Annotations v1 を使用してください。
インテグレーションテンプレートは、Kubernetes のポッドアノテーションに格納できます。オートディスカバリーを使用して、Agent は、自身が Kubernetes 上で実行されているかどうかを検出し、すべてのポッドアノテーションでインテグレーションテンプレートを自動的に探します。
特定のコンフィギュレーションを特定のコンテナに適用するために、オートディスカバリーはコンテナをイメージではなく、名前で識別します。つまり、<コンテナ識別子>
は、.spec.containers[0].image
とではなく .spec.containers[0].name
との一致が試みられます。ポッド内の特定の <コンテナ識別子>
で Datadog インテグレーションのオートディスカバリーを構成するには、以下のアノテーションをポッドに追加します。
apiVersion: v1
kind: Pod
# (...)
metadata:
name: '<POD_NAME>'
annotations:
ad.datadoghq.com/<CONTAINER_IDENTIFIER>.checks: |
{
"<INTEGRATION_NAME>": {
"init_config": <INIT_CONFIG>,
"instances": [<INSTANCE_CONFIG>]
}
}
# (...)
spec:
containers:
- name: '<CONTAINER_IDENTIFIER>'
# (...)
init_config
は通常、空の {}
です。AD Annotations v2 では、この設定はオプションです。
ポッド内の 2 つの異なるコンテナ <CONTAINER_IDENTIFIER_1>
と <CONTAINER_IDENTIFIER_2>
に 2 つの異なるインテグレーションテンプレートを適用するには、次のアノテーションをポッドに追加します。
apiVersion: v1
kind: Pod
# (...)
metadata:
name: '<POD_NAME>'
annotations:
ad.datadoghq.com/<CONTAINER_IDENTIFIER_1>.checks: |
{
"<INTEGRATION_NAME_1>": {
"init_config": <INIT_CONFIG_1>,
"instances": [<INSTANCE_CONFIG_1>]
}
}
ad.datadoghq.com/<CONTAINER_IDENTIFIER_2>.checks: |
{
"<INTEGRATION_NAME_2>": {
"init_config": <INIT_CONFIG_2>,
"instances": [<INSTANCE_CONFIG_2>]
}
}
spec:
containers:
- name: '<CONTAINER_IDENTIFIER_1>'
# (...)
- name: '<CONTAINER_IDENTIFIER_2>'
# (...)
kind: Pod
を使用して Kubernetes ポッドを直接定義する場合は、各ポッドのアノテーションを metadata
セクションの真下に追加します。レプリケーションコントローラー、レプリカセット、またはデプロイメントを使用してポッドを間接的に定義する場合は、ポッドアノテーションを .spec.template.metadata
の下に追加します。
注: Datadog では、コンテナ化環境のベストプラクティスとして、タグを付ける際に統合サービスタグ付けを使用することをおすすめしています。統合サービスタグ付けは、env
、service
、version
の 3 つの標準タグを使用して Datadog テレメトリーと結合します。ご使用環境で統合タグ付けを構成する方法に関する詳細は、統合サービスタグ付けドキュメントをご参照ください。
インテグレーションテンプレートは、Kubernetes のポッドアノテーションに格納できます。オートディスカバリーを使用して、Agent は、自身が Kubernetes 上で実行されているかどうかを検出し、すべてのポッドアノテーションでインテグレーションテンプレートを自動的に探します。
特定のコンフィギュレーションを特定のコンテナに適用するために、オートディスカバリーはコンテナをイメージではなく、名前で識別します。つまり、<コンテナ識別子>
は、.spec.containers[0].image
とではなく .spec.containers[0].name
との一致が試みられます。ポッド内の特定の <コンテナ識別子>
で Datadog インテグレーションのオートディスカバリーを構成するには、以下のアノテーションをポッドに追加します。
apiVersion: v1
kind: Pod
# (...)
metadata:
name: '<ポッド名>'
annotations:
ad.datadoghq.com/<コンテナ識別子>.check_names: '[<インテグレーション名>]'
ad.datadoghq.com/<コンテナ識別子>.init_configs: '[<初期コンフィギュレーション>]'
ad.datadoghq.com/<コンテナ識別子>.instances: '[<インスタンスコンフィギュレーション>]'
# (...)
spec:
containers:
- name: '<コンテナ識別子>'
# (...)
ポッド内の 2 つの異なるコンテナ <CONTAINER_IDENTIFIER_1>
と <CONTAINER_IDENTIFIER_2>
に 2 つの異なるインテグレーションテンプレートを適用するには、次のアノテーションをポッドに追加します。
apiVersion: v1
kind: Pod
# (...)
metadata:
name: '<ポッド名>'
annotations:
ad.datadoghq.com/<コンテナ識別子_1>.check_names: '[<インテグレーション名_1>]'
ad.datadoghq.com/<コンテナ識別子_1>.init_configs: '[<初期コンフィギュレーション_1>]'
ad.datadoghq.com/<コンテナ識別子_1>.instances: '[<インスタンスコンフィギュレーション_1>]'
# (...)
ad.datadoghq.com/<コンテナ識別子_2>.check_names: '[<インテグレーション名_2>]'
ad.datadoghq.com/<コンテナ識別子_2>.init_configs: '[<初期コンフィギュレーション_2>]'
ad.datadoghq.com/<コンテナ識別子_2>.instances: '[<インスタンスコンフィギュレーション_2>]'
spec:
containers:
- name: '<コンテナ識別子_1>'
# (...)
- name: '<コンテナ識別子_2>'
# (...)
kind: Pod
を使用して Kubernetes ポッドを直接定義する場合は、各ポッドのアノテーションを metadata
セクションの真下に追加します。レプリケーションコントローラー、レプリカセット、またはデプロイメントを使用してポッドを間接的に定義する場合は、ポッドアノテーションを .spec.template.metadata
の下に追加します。
注: Datadog では、コンテナ化環境のベストプラクティスとして、タグを付ける際に統合サービスタグ付けを使用することをおすすめしています。統合サービスタグ付けは、env
、service
、version
の 3 つの標準タグを使用して Datadog テレメトリーと結合します。ご使用環境で統合タグ付けを構成する方法に関する詳細は、統合サービスタグ付けドキュメントをご参照ください。
テンプレートをローカルファイルとして保存し、それをコンテナ化 Agent 内にマウントする場合は、外部サービスや特定のオーケストレーションプラットフォームを必要としません。この方法の欠点は、テンプレートを変更、追加、または削除するたびに、Agent コンテナを再起動する必要がある点です。Agent は、マウントされた /conf.d
ディレクトリでオートディスカバリーテンプレートを探します。
Agent v6.2.0 (および v5.24.0) 以降、デフォルトテンプレートはポートを自動検出するのではなく、監視対象ソフトウェアのデフォルトポートを使用します。別のポートを使用する必要がある場合は、Kubernetes ポッドアノテーションで、カスタムオートディスカバリーテンプレートを指定します。
デフォルトのインテグレーションテンプレートは、基本的なケース向けです。追加オプションを有効にするためにカスタム Datadog インテグレーション構成が必要な場合は、別のコンテナ識別子を使用します。あるいは、テンプレート変数インデックスを使用して、独自のオートディスカバリー構成ファイルを作成します。
- ホストに
conf.d/<INTEGRATION_NAME>.d/conf.yaml
ファイルを作成し、カスタムオートディスカバリー構成を追加します。 - ホスト の
conf.d/
フォルダーをコンテナ化 Agent の conf.d
フォルダーにマウントします。
オートディスカバリー構成ファイル例:
ad_identifiers:
<INTEGRATION_AUTODISCOVERY_IDENTIFIER>
init_config:
<INIT_CONFIG>
instances:
<INSTANCES_CONFIG>
<INTEGRATION_AUTODISCOVERY_IDENTIFIER>
の詳細については、オートディスカバリーコンテナ識別子のドキュメントを参照してください。
注: Agent はファイル名から直接 <INTEGRATIONS_NAME>
を推測するため、この名前を設定する必要はありません。
Kubernetes では、ConfigMaps を使用して外部でコンフィギュレーションを定義し、その後マニフェストを使用してマウントすることができます。以下のテンプレートと Kubernetes カスタムインテグレーションのドキュメントを参照してください。
kind: ConfigMap
apiVersion: v1
metadata:
name: "<名前>-config-map"
namespace: default
data:
<インテグレーション名>-config: |-
ad_identifiers:
<インテグレーションオートディスカバリー識別子>
init_config:
<初期コンフィギュレーション>
instances:
<インスタンスコンフィギュレーション>
<INTEGRATION_AUTODISCOVERY_IDENTIFIER>
の詳細については、オートディスカバリーコンテナ識別子のドキュメントを参照してください。
オートディスカバリーでは、Consul、Etcd、および Zookeeper をインテグレーションテンプレートソースとして使用できます。key-value ストアを使用するには、Agent の datadog.yaml
構成ファイルでストアを構成し、このファイルをコンテナ化 Agent 内にマウントします。あるいは、key-value ストアを環境変数としてコンテナ化 Agent に渡します。
datadog.yaml での構成
datadog.yaml
ファイルで、key-value ストアの <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:
次に、Agent を再起動して、構成の変更を適用します。
環境変数での構成
注: Datadog では、コンテナ化環境のベストプラクティスとして、タグおよび環境変数を構成する際に統合サービスタグ付けを使用することをお勧めしています。統合サービスタグ付けは、env
、service
、version
の 3 つの標準タグを使用して Datadog テレメトリーと結合します。ご使用環境で統合タグ付けを構成する方法に関する詳細は、[統合サービスタグ付け][9]ドキュメントをご参照ください。
key-value ストアがテンプレートソースとして有効になっている場合、Agent はキー /datadog/check_configs
の下でテンプレートを探します。オートディスカバリーは、以下のような key-value 階層を前提とします。
/datadog/
check_configs/
<コンテナ識別子>/
- check_names: ["<インテグレーション名>"]
- init_configs: ["<初期コンフィギュレーション>"]
- instances: ["<インスタンスコンフィギュレーション>"]
...
注: key-value ストアを使用している場合、オートディスカバリーは特定の構成を特定のコンテナに適用するために、<CONTAINER_IDENTIFIER>
と .spec.containers[0].image
の一致を試みることで、コンテナをイメージで識別します。
values.yaml
ファイルには、静的およびオートディスカバリーのインテグレーションチェックの両方を定義する confd
セクションが含まれています。サンプル values.yaml に、インラインの例があります。各キーは、Agent の conf.d
ディレクトリのファイルになります。
confd:
<INTEGRATION_NAME>.yaml: |-
ad_identifiers:
- <INTEGRATION_AUTODISCOVERY_IDENTIFIER>
init_config:
- <INIT_CONFIG>
instances:
- <INSTANCES_CONFIG>
<INTEGRATION_AUTODISCOVERY_IDENTIFIER>
の詳細については、オートディスカバリーコンテナ識別子を参照してください。
注: Helm チャートには 2 つの confd
セクション(Agent チェック用とクラスターチェック用)があります。Cluster Agent を使用しクラスターチェックにオートディスカバリーを構成する場合は、クラスターチェックのコンフィギュレーション例に従い、必ず cluster_check: true
を含めます。詳しいコンテキストについては、クラスターチェックを参照してください。
DatadogAgent
構成の nodeAgent
コンポーネントにオーバーライドの extraConfd.configDataMap
を追加することで、静的およびオートディスカバリーのインテグレーションチェックの両方を定義することができます。各キーが Agent の conf.d
ディレクトリのファイルになります。
apiVersion: datadoghq.com/v2alpha1
kind: DatadogAgent
metadata:
name: datadog
spec:
global:
[...]
features:
[...]
override:
nodeAgent:
extraConfd:
configDataMap:
<INTEGRATION_NAME>.yaml: |-
ad_identifiers:
- <INTEGRATION_AUTODISCOVERY_IDENTIFIER>
init_config:
- <INIT_CONFIG>
instances:
- <INSTANCES_CONFIG>
<INTEGRATION_AUTODISCOVERY_IDENTIFIER>
の詳細については、オートディスカバリーコンテナ識別子を参照してください。
注: Cluster Agent を使用していて、クラスターチェック用のオートディスカバリーを構成したい場合は、clusterAgent
コンポーネントにオーバーライドの extraConfd.configDataMap
を追加し、必ず cluster_check: true
を入れてください。詳細については、クラスターチェックを参照してください。