概要

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

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

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

注:

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

要件

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

• Unified service tagging には、予約済みタグ の新しい構成をサポートする SDK バージョンが必要です。詳しい情報については、セットアップ手順 に言語ごとに記載されています。

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

構成

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

• コンテナ化
• 非コンテナ化
• Serverless
• OpenTelemetry

コンテナ化環境

コンテナ化環境において、env、service、および version は、サービスの環境変数またはラベル (Kubernetes の デプロイメントと Pod ラベル、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 で Datadog SDKを構成することにより、env の定義が、トレースを生成しているアプリケーションに近くなるようにしてください。この方法では、env タグがスパンメタデータのタグから自動的に取得されるようになります。

   2. DD_VERSION でスパンを構成することにより、SDK に属するサービスに該当するすべてのスパンにバージョンを追加します (一般的に DD_SERVICE)。したがって、サービスにより外部サービスの名前でスパンが作成された場合、それらのスパンには version がタグとして追加されません。

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

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

   接続されているログとトレースを使用している場合、Datadog SDK が自動ログ取り込みをサポートしているなら、それを有効にしてください。その場合、Datadog SDK は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 つの値がある場合、メトリクスには両方の環境がタグ付けされます。同じ名前のタグが他のタグをオーバーライドする順序はありません。

   サービスが 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 アプリでのタグの使用方法ドキュメント Datadog APM 内の Version タグを使用してデプロイを監視するドキュメント オートディスカバリーの詳細ブログ