DogStatsD Mapper

Agent バージョン 7.17+ では、DogStatsD Mapper 機能でマッピング規則とワイルドカード、正規表現パターンを使用して、DogStatsD に送信されたメトリクス名の一部をタグに変換できるようになりました。たとえば、以下のようなメトリクスの変換が可能です。

  • airflow.job.duration.<ジョブ種類>.<ジョブ名>

これは 2 つの関連するタグを使用して airflow.job.duration メトリクスに変換することができます。

  • job_type:<ジョブ種類>
  • job_name:<ジョブ名>.

以下の手順でマッピング規則を作成します。

  1. datadog.yaml ファイルを開きます
  2. dogstatsd_mapper_profiles パラメーター下にマッピング規則のコンフィギュレーションブロックを追加します。

マッピング規則のコンフィギュレーション

マッピング規則ブロックは以下のようなレイアウトになります。

dogstatsd_mapper_profiles:
    - name: <PROFILE_NAME>
      prefix: <PROFILE_PREFIX>
      mappings:
          - match: <METRIC_TO_MATCH>
            match_type: <MATCH_TYPE>
            name: <MAPPED_METRIC_NAME>
            tags:
                <TAG_KEY>: <TAG_VALUE_TO_EXPAND>

次のプレースホルダーと組み合わせます。

プレースホルダー定義必須
<プロファイル名>マッピング規則のプロファイルに付与する名称。はい
<プロファイルのプレフィックス>プロファイルに関連付けられているメトリクス名のプレフィックス。はい
<一致するメトリクス>ワイルドカード または 正規表現 の一致ロジックを使ってグループを抽出するためのメトリクス名。はい
<一致タイプ><一致するメトリクス>に適用する一致タイプ。ワイルドカード または 正規表現 のいずれかとなります。いいえ / デフォルト: wildcard
<マッピング済みのメトリクス名>同じグループで定義されたタグと共に Datadog に送信する新しいメトリクス名。はい
<タグキー>収集されたタグに関連付けるタグキー。いいえ
<展開するタグ値><一致タイプ> からインラインに収集するタグ。いいえ

ワイルドカードの一致パターン

ワイルドカードの一致パターンは、* をワイルドカードに用いたドット区切りのメトリクス名と一致します。このパターンを使用する場合、メトリクス名には英数字、._ のみ使用できます。抽出されたグループは、以下のいずれかで展開が可能です。

  • $n 形式: $1$2$3 など
  • ${n} 形式: ${1}${2}${3} など

たとえば、以下のマッピンググループコンフィギュレーションを持つメトリクス custom_metric.process.value_1.value_2 について見てみましょう。

dogstatsd_mapper_profiles:
    - name: my_custom_metric_profile
      prefix: custom_metric.
      mappings:
          - match: custom_metric.process.*.*
            match_type: wildcard
            name: custom_metric.process
            tags:
                tag_key_1: $1
                tag_key_2: $2

メトリクス custom_metric.process にタグ tag_key_1:value_1 および tag_key_2:value_2 が付与され、Datadog に送られます。

正規表現の一致パターン

正規表現の一致パターンは、正規表現パターンを使用したメトリクス名と一致します。ワイルドカードの一致パターンとは異なり、. を含むキャプチャされたグループを定義することができます。抽出されたグループは、以下のいずれかで展開が可能です。

  • $n 形式: $1$2$3 など
  • ${n} 形式: ${1}${2}${3} など

たとえば、以下のマッピンググループコンフィギュレーションを持つメトリクス custom_metric.process.value_1.value.with.dots._2 について見てみましょう。

dogstatsd_mapper_profiles:
    - name: my_custom_metric_profile
      prefix: custom_metric.
      mappings:
          - match: custom_metric\.process\.([\w_]+)\.(.+)
            match_type: regex
            name: custom_metric.process
            tags:
                tag_key_1: $1
                tag_key_2: $2

メトリクス custom_metric.process にタグ tag_key_1:value_1 および tag_key_2:value.with.dots._2 が付与され、Datadog に送られます。

メトリクス名でグループを展開する

regex および wildcard の一致パターンでは、上記のように、収集されたグループを関連するタグキーが付いたタグ値として展開することができます。メトリクス name のパラメーターとして使用することも可能です。たとえば、以下のマッピンググループコンフィギュレーションにメトリクス custom_metric.process.value_1.value_2 がある場合は以下のようになります。

dogstatsd_mapper_profiles:
    - name: my_custom_metric_profile
      prefix: custom_metric.
      mappings:
          - match: custom_metric.process.*.*
            match_type: wildcard
            name: custom_metric.process.prod.$1.live
            tags:
                tag_key_2: $2

メトリクス custom_metric.process.prod.value_1.live にタグ tag_key_2:value_2 が付与され、Datadog に送られます。

その他の参考資料