概要

統合サービスタグ付けは、3 つの予約済みタグである env、service、version を使用して Datadog テレメトリを結び付けます。

これら 3 つのタグを使用すると、次のことができます。

• バージョンでフィルタリングされたトレースおよびコンテナメトリクスを使用してデプロイの影響を特定する
• 一貫性のあるタグを使用して、トレース、メトリクス、ログ間をシームレスに移動する
• 統一された方法で環境やバージョンに基づいてサービスデータを表示する

注:

• version タグは、新しいアプリケーションのデプロイごとに変更されることが期待されています。アプリケーションのコードに異なる 2 つのバージョンがある場合、それぞれに異なる version タグが付けられるべきです。
• オートディスカバリーログの構成が存在しない場合、ログの公式サービスはデフォルトでコンテナのショートイメージになります。ログの公式サービスを上書きするには、オートディスカバリーの Docker ラベル/ポッドアノテーションを追加します。例: "com.datadoghq.ad.logs"='[{"service": "service-name"}]'
• スパンに関連付けられたホストはデータベース/キャッシュホストではないため、ホスト情報はデータベースとキャッシュスパンでは除外されます。

要件

• 統合サービスタグ付けには、Datadog Agent 6.19.x/7.19.x 以上のセットアップが必要です。

• 統合サービスタグ付けには、予約済みタグの新しい構成に対応するトレーサーのバージョンが必要です。詳細は、言語別のセットアップ手順をご覧ください。

• 統合サービスタグ付けには、タグの構成に関する知識が必要です。タグの構成方法がわからない場合は、構成に進む前に、タグの概要およびタグの付け方のドキュメントをお読みください。

構成

統合サービスタグ付けの構成を開始するには、環境を選択します。

• コンテナ化
• 非コンテナ化
• サーバーレス
• OpenTelemetry

コンテナ化環境

コンテナ化環境では、env、service、version は、サービスの環境変数またはラベル（Kubernetes のデプロイやポッドラベル、Docker コンテナラベルなど）を介して設定されます。Datadog Agent はこのタグ付け構成を検出し、コンテナから収集するデータに適用します。

コンテナ化環境で統合サービスタグ付けをセットアップするには

1. オートディスカバリーを有効にします。これにより、Datadog Agent は特定のコンテナで実行されているサービスを自動的に識別し、そのサービスからデータを収集して、環境変数を env、service、version タグにマッピングできます。

2. Docker を使用している場合は、Agent がコンテナの Docker ソケットにアクセスできることを確認してください。これにより、Agent は環境変数を検出し、それを標準タグにマッピングできます。

3. コンテナオーケストレーションサービスに対応する環境は、以下のように完全構成または部分構成のいずれかに基づいて構成します。

構成

apiVersion: apps/v1
kind: Deployment
metadata:
  labels:
    tags.datadoghq.com/env: "<ENV>"
    tags.datadoghq.com/service: "<SERVICE>"
    tags.datadoghq.com/version: "<VERSION>" 
...
template:
  metadata:
    labels:
      tags.datadoghq.com/env: "<ENV>"
      tags.datadoghq.com/service: "<SERVICE>"
      tags.datadoghq.com/version: "<VERSION>" 
  containers:
  -  ...
     env:
          - name: DD_ENV
            valueFrom:
              fieldRef:
                fieldPath: metadata.labels['tags.datadoghq.com/env']
          - name: DD_SERVICE
            valueFrom:
              fieldRef:
                fieldPath: metadata.labels['tags.datadoghq.com/service']
          - name: DD_VERSION 
            valueFrom: 
              fieldRef: 
                fieldPath: metadata.labels['tags.datadoghq.com/version']

  containers:
  -  ...
     env:
         - name: OTEL_RESOURCE_ATTRIBUTES
           value: "service.name=<SERVICE>,service.version=<VERSION>,deployment.environment=<ENV>"
         - name: OTEL_SERVICE_NAME
           value: "<SERVICE>"

template:
  metadata:
    labels:
      tags.datadoghq.com/env: "<ENV>"
      tags.datadoghq.com/service: "<SERVICE>"
      tags.datadoghq.com/version: "<VERSION>" 

tags.datadoghq.com/<container-name>.env
tags.datadoghq.com/<container-name>.service
tags.datadoghq.com/<container-name>.version 

apiVersion: apps/v1
kind: Deployment
metadata:
  labels:
    tags.datadoghq.com/env: "<ENV>"
    tags.datadoghq.com/service: "<SERVICE>"
    tags.datadoghq.com/version: "<VERSION>" 
spec:
  template:
    metadata:
      labels:
        tags.datadoghq.com/env: "<ENV>"
        tags.datadoghq.com/service: "<SERVICE>"
        tags.datadoghq.com/version: "<VERSION>" 

containers:
-  ...
    env:
        - name: DD_ENV
          valueFrom:
            fieldRef:
              fieldPath: metadata.labels['tags.datadoghq.com/env']
        - name: DD_SERVICE
          valueFrom:
            fieldRef:
              fieldPath: metadata.labels['tags.datadoghq.com/service']
        - name: DD_VERSION 
          valueFrom: 
            fieldRef: 
              fieldPath: metadata.labels['tags.datadoghq.com/version'] 

ENV DD_SERVICE <SERVICE>
ENV DD_VERSION <VERSION> 

LABEL com.datadoghq.tags.service="<SERVICE>"
LABEL com.datadoghq.tags.version="<VERSION>" 

docker run -e DD_ENV=<ENV> -l com.datadoghq.tags.env=<ENV> ...

docker run -e DD_ENV="<ENV>" \
           -e DD_SERVICE="<SERVICE>" \
           -e DD_VERSION="<VERSION>" \ 
           -l com.datadoghq.tags.env="<ENV>" \
           -l com.datadoghq.tags.service="<SERVICE>" \
           -l com.datadoghq.tags.version="<VERSION>" \ 
           ...

com.datadoghq.tags.env
com.datadoghq.tags.service
com.datadoghq.tags.version 

"environment": [
  {
    "name": "DD_ENV",
    "value": "<ENV>"
  },
  {
    "name": "DD_SERVICE",
    "value": "<SERVICE>"
  },
  {
    "name": "DD_VERSION",
    "value": "<VERSION>"
  }

],
"dockerLabels": {
  "com.datadoghq.tags.env": "<ENV>",
  "com.datadoghq.tags.service": "<SERVICE>",
  "com.datadoghq.tags.version": "<VERSION>"
}

"dockerLabels": {
  "com.datadoghq.tags.env": "<ENV>",
  "com.datadoghq.tags.service": "<SERVICE>",
  "com.datadoghq.tags.version": "<VERSION>"
}

非コンテナ化環境

サービスのバイナリまたは実行可能ファイルをどのように構築およびデプロイするかによって、環境変数を設定するためのオプションをいくつか利用できる場合があります。ホストごとに 1 つ以上のサービスを実行する可能性があるため、Datadog ではこれらの環境変数のスコープを単一プロセスにすることをお勧めします。

トレース、ログ、RUMリソース、Synthetic テスト、StatsD メトリクス、またはシステムメトリクスのサービスのランタイムから直接送信されるすべてのテレメトリーの構成の単一ポイントを形成するには、次のいずれかを実行します。

1. 実行可能ファイルのコマンドで環境変数をエクスポートします。

   DD_ENV=<env> DD_SERVICE=<service> DD_VERSION=<version> /bin/my-service
   

2. または、Chef、Ansible、または別のオーケストレーションツールを使用して、サービスの systemd または initd コンフィギュレーションファイルに DD 環境変数を設定します。サービスプロセスが開始すると、その変数にアクセスできるようになります。

   統合サービスタグ付けのトレースを構成する場合

   1. DD_ENV で APM トレーサーを構成し、トレースを生成しているアプリケーションに env の定義を近づけます。このメソッドを使用すると、env タグをスパンメタデータのタグから自動的に取得できます。

   2. DD_VERSION でスパンを構成して、トレーサーに属するサービス (通常は DD_SERVICE) に属するすべてのスパンにバージョンを追加します。これは、サービスが外部サービスの名前でスパンを作成する場合、そのスパンはタグとして version を受信しないことを意味します。

      バージョンがスパンに存在する限り、そのスパンから生成されたメトリクスをトレースするために追加されます。バージョンは、手動でコード内に追加するか、APM トレーサーによって自動的に追加できます。構成すると、これらは APM および DogStatsD クライアントによって使用され、トレースデータと StatsD メトリクスに env、service、version でタグ付けします。有効にすると、APM トレーサーはこの変数の値もログに注入します。

      注: スパンごとに 1 つのサービスしか存在できません。トレースメトリクスには、通常、単一のサービスもあります。ただし、ホストのタグで異なるサービスが定義されている場合、その構成されたサービスタグは、そのホストから発行されたすべてのトレースメトリクスに表示されます。

   接続されたログとトレースを使用している場合、APM トレーサーでサポートされている場合は、自動ログ注入を有効にします。そうすれば、APM トレーサーは、自動的に env、service、version をログに注入するため、他の場所でこれらのフィールドを手動で構成する必要がなくなります。

   接続された RUM とトレースを使用する場合、初期化ファイルの service フィールドにブラウザアプリケーションを指定し、env フィールドに環境を定義し、version フィールドにバージョンを記載します。

   RUM アプリケーションを作成する際に、env と service の名前を確認します。

   接続された Synthetic ブラウザのテストとトレースをご利用の場合、Integration Settings ページの APM Integration for Browser Tests セクションでヘッダー送信先 URL を指定してください。

   ワイルドカードとして * を使用することができます。例えば、https://*.datadoghq.com のように指定します。

   タグは、カスタム StatsD メトリクスの付加のみの方法で追加されます。たとえば、env に 2 つの異なる値がある場合、メトリクスは両方の環境でタグ付けされます。1 つのタグが同じ名前の別のタグをオーバーライドする順序はありません。

   サービスが DD_ENV、DD_SERVICE、DD_VERSION にアクセスできる場合、DogStatsD クライアントは対応するタグをカスタムメトリクスに自動的に追加します。

   注: .NET および PHP 用の Datadog DogStatsD クライアントは、この機能をサポートしていません。

   インフラストラクチャーメトリクスには、env タグと service タグを追加することができます。コンテナ化されていないコンテキストでは、サービスメトリクスのタグ付けは Agent レベルで構成されます。

   この構成はサービスのプロセスを呼び出すたびに変更されるわけではないので、version を追加することは推奨されません。

   ホスト毎の単一サービス

   Agent のメインコンフィギュレーションファイルに、以下の構成を適用します。

   env: <ENV>
   tags:
     - service:<SERVICE>
   

   この設定により、Agent が送信するすべてのデータに対する env と service のタグ付けの一貫性が保証されます。

   ホスト毎の複数のサービス

   Agent のメインコンフィギュレーションファイルに、以下の構成を適用します。

   env: <ENV>
   

   CPU、メモリ、ディスク I/O のメトリクスに一意の service タグをプロセスレベルで取得するには、Agent の構成フォルダ (例えば、process.d/conf.yaml 下の conf.d フォルダ) でプロセスチェックを構成します。

   init_config:
   instances:
       - name: web-app
         search_string: ["/bin/web-app"]
         exact_match: false
         service: web-app
       - name: nginx
         search_string: ["nginx"]
         exact_match: false
         service: nginx-web-app
   

   注: Agent のメインコンフィギュレーションファイルで既に service タグをグローバルに設定している場合は、プロセスのメトリクスが 2 つのサービスにタグ付けされます。これによってメトリクスの解釈に相違が生じることがあるため、service タグはプロセスチェックの構成のみで構成することをお勧めします。

サーバーレス環境

AWS Lambda 関数については、タグを使った Lambda のテレメトリー接続方法を参照してください。

OpenTelemetry

OpenTelemetry を使用する場合、以下のリソース属性 を、対応する Datadog 規則にマッピングします。

1: deployment.environment は OpenTelemetry セマンティック規約 v1.27.0 において deployment.environment.name が推奨されるため非推奨となります。 2: deployment.environment.name は Datadog Agent 7.58.0+ および Datadog Exporter v0.110.0+ でサポートされています。

export OTEL_RESOURCE_ATTRIBUTES="service.name=my-service,deployment.environment=production,service.version=1.2.3"

from opentelemetry.sdk.resources import Resource
from opentelemetry.sdk.trace import TracerProvider

resource = Resource(attributes={
   "service.name": "<SERVICE>",
   "deployment.environment": "<ENV>",
   "service.version": "<VERSION>"
})
tracer_provider = TracerProvider(resource=resource)

processors:
  transform:
    trace_statements:
      - context: resource
        statements:
          - set(attributes["service.name"], "my-service")
          - set(attributes["deployment.environment"], "production")
          - set(attributes["service.version"], "1.2.3")
...

その他の参考資料

お役に立つドキュメント、リンクや記事:

Datadog アプリでのタグの使用方法DOCUMENTATION Datadog APM 内の Version タグを使用してデプロイを監視するDOCUMENTATION オートディスカバリーの詳細ブログ