OTLP メトリクスタイプ

概要

Datadog Agent と OpenTelemetry Collector Datadog エクスポーターは、OpenTelemetry でインスツルメントされたアプリケーションで生成できる OTLP (OpenTelemetry フォーマット) のメトリクスをインジェストすることができます。

以下の OTLP メトリクスタイプは、Datadog Agent と OpenTelemetry Collector Datadog エクスポーターでインジェストすることができます。

  • Sums
  • ゲージ
  • ヒストグラム
  • Summaries

これらの OTLP のメトリクスタイプは、Datadog のメトリクスタイプにマッピングされます。

  • COUNT
  • GAUGE
  • DISTRIBUTION

1 つの OTLP メトリクスは、その意味を示すサフィックスを持つ複数の Datadog メトリクスにマッピングされることがあります。

: OpenTelemetry はメトリクス API のインスツルメント (GaugeCounterUpDownCounterHistogram など) を提供しており、それらの計測値は OTLP メトリクス (Sum、Gauge、Histogram) としてエクスポートすることが可能です。OTLP メトリクスの他のソースも可能です。アプリケーションやライブラリは、生成する OTLP のメトリクスをカスタマイズすることができます。生成される OTLP メトリクスとそのカスタマイズ方法を理解するために、OpenTelemetry SDK または OTLP 生成アプリケーションのドキュメントをお読みください。

: OpenTelemetry プロトコルは、メトリクスを時間で表現する 2 つの方法をサポートしています。累積一時性とデルタ一時性があり、以下に説明するメトリクスに影響します。CUMULATIVE に設定すると、アプリケーション (またはコレクター) の起動時にいくつかのデータポイントを破棄する可能性があるため、OpenTelemetry 実装の一時性設定を DELTA に設定します。詳細については、OpenTelemetry によるデルタ一時性メトリクスの生成をお読みください。

メトリクスタイプ

マッピング

OTLP Sum は、あるタイムウィンドウで報告された測定値の合計を表します。例えば、データベースへの接続の総数やエンドポイントへのリクエストの総数を追跡するために、Sum を使うことができます。Sum にはマッピングに影響を与える 2 つの特徴があります。

  • Aggregation temporality、これは累積とデルタがあります。デルタメトリクスはタイムウィンドウが重ならないが、累積メトリクスは時間的に固定された開始点からのタイムウィンドウを表します。
  • Monotonicity。モノトニックサムは決して減少せず、基礎となるカウントに追加することのみをサポートします。

デフォルトのマッピングは以下の通りです。

  1. 累積モノトニックサムでは、連続するポイント間のデルタが計算され、カウントとして Datadog に報告されます。最初のポイントは保存されるが省略されます。OTLP ペイロードの値を復元するには、cumsum 算術関数を使用します。
  2. 累積非モノトニックサムは Datadog ゲージとしてエクスポートされます。
  3. デルタサムは、Datadog のカウントとしてエクスポートされます。

OTLP Gauge は、ある時刻にサンプリングされた値を表します。与えられたタイムウィンドウの最後の値だけが、OTLP のメトリクスに含まれます。

OTLP Gauge は集計セマンティックを提供しないので、Datadog Gauge にマップされます。整数と浮動小数点の両方の Gauge データポイントが Datadog のフォーマットで浮動小数点数にマップされます。

OTLP Histogram は、母集団の合計やカウントなどの特定の集計メトリクスを一連のバケットカウントとともに保存することで、与えられたタイムウィンドウにおける値の集合の統計的分布を表現するものです。ヒストグラムはマッピングに影響を与える 1 つの特徴を持っています。

  • Aggregation temporality、これは累積とデルタがあります。デルタメトリクスはタイムウィンドウが重ならないが、累積メトリクスは時間的に固定された開始点からのタイムウィンドウを表します。

デフォルトのマッピングは以下の通りです。

  1. デルタヒストグラムは、Datadog の分布として報告されます。利用可能な集計について理解するために、分布についての詳細をお読みください
  2. 累積ヒストグラムの場合、連続するポイント間のデルタが計算され、分布として Datadog に報告されます。OTLP ペイロードの値を復元するために、個々の集計で cumsum 算術関数を使用することができます。

: OTLP のヒストグラムメトリクスは、ディストリビューションメトリクスにマッピングされています。OTLP がこのデータを送信する方法のため、最大、最小、およびパーセンタイルの集計は、正確な計算ではなく、近似値です。

Datadog Agent と OpenTelemetry Collector Datadog エクスポーターでは、histogram サブセクションで Histogram エクスポートを変更することができます。

  • modecounters を指定すると、以下のようなメトリクスが生成されます。
<METRIC_NAME>.bucketlower_boundupper_bound でタグ付けされています
指定された下限値と上限値を持つバケットのタイムウィンドウにおけるバケット数。
Datadog In-App Type: COUNT
  • send_aggregation_metrics フラグが有効な場合、以下のメトリクスが生成されます。
<METRIC_NAME>.sum
タイムウィンドウ内に送信された値の総和。
Datadog In-App Type: COUNT
<METRIC_NAME>.count
タイムウィンドウ内に送信された値の数。
Datadog In-App Type: COUNT
<METRIC_NAME>.min
タイムウィンドウで送信された値の最小値。delta OTLP ヒストグラムでのみ利用可能です。Datadog エクスポーター v0.75.0 および Datadog Agent v6.45.0 および v7.45.0 以降利用可能です。
Datadog アプリ内タイプ: GAUGE
<METRIC_NAME>.max
タイムウィンドウで送信された値の最大値。delta OTLP ヒストグラムでのみ利用可能です。Datadog エクスポーター v0.75.0 および Datadog Agent v6.45.0 および v7.45.0 以降利用可能です。
Datadog アプリ内タイプ: GAUGE

: send_aggregation_metrics は、ディストリビューションモードを使用していない場合にのみ有効です。Datadog エクスポーター v0.75.0 以前、Datadog Agent v6.45.0 および v7.45.0 では、代わりに send_count_sum_metrics を使用します。

OTLP Summary は、タイムウィンドウにわたる母集団の分位情報を伝えるレガシータイプです。OTLP Summary タイプは OpenTelemetry SDK では生成されませんが、後方互換性のために他のコンポーネントで生成されることがあります。

<METRIC_NAME>.sum
アプリケーションがメトリクスの生成を開始してからの値の総和。
Datadog In-App Type: COUNT
<METRIC_NAME>.count
母集団に含まれる値の数。
Datadog In-App Type: COUNT
<METRIC_NAME>.quantilequantile でタグ付けされています
指定された分位数の値。
Datadog In-App Type: GAUGE

属性のマッピング

OTLP はデータポイントレベルの属性とリソース属性の 2 種類の属性をサポートしています。これらの属性は OpenTelemetry のセマンティック規則に従い、よく知られたセマンティックを持つことができます。

Datadog Agent と OpenTelemetry Collector Datadog エクスポーターは、データポイントレベルの属性をタグとしてマッピングします。OpenTelemetry のセマンティック規則に従ったリソース属性は、同等の Datadog 規則が存在すればそれにマッピングされます。

resource_attributes_as_tags フラグを使用すると、すべてのリソースの属性をタグとして追加することができます。

ホスト名解決

OpenTelemetry は、ホスト名に関する特定のセマンティック規則を定義しています。OTLP ペイロードが既知のホスト名属性を持つ場合、Datadog はこれらの規則に従い、その値をホスト名として使用しようとします。セマンティック規則は、以下の順序で考慮されます。

  1. 存在する場合に二重タグを避ける host 属性。
  2. datadog.host.name、Datadog 固有のホスト名規則
  3. クラウドプロバイダー固有の規則、cloud.provider セマンティック規則がベース
  4. Kubernetes 固有のセマンティック規約である k8s.node.namek8s.cluster.name
  5. host.id、一意のホスト ID
  6. host.name、システムホスト名

以下のホスト名は無効とみなされ、破棄されます。

  1. 0.0.0.0
  2. 127.0.0.1
  3. localhost
  4. localhost.localdomain
  5. localhost6.localdomain6
  6. ip6-localhost

有効なホスト名が存在しない場合、Datadog はペイロードにシステムレベルのホスト名を割り当てます。 リモートホストからデータを送信する場合、パイプラインに ‘resource detection’ プロセッサーを追加することで、正確なホスト名解決を行うことができます。

デフォルトでは、累積モノトニック Sum タイプのメトリクスをエクスポートする、単一のアプリケーションから OpenTelemetry Counter インスツルメントを使用しているとします。次の表は、Datadog の動作をまとめたものです。

収集期間Counter 値OTLP Sum 値Datadog に報告される値Datadog アプリ内タイプ
#1[1,1,1,2,2,2,3,3]15なしCOUNT最初の収集期間の数値は報告されません。
#2[3,4,1,2]2510COUNT値の差が報告されます。
#3[]250COUNTこの期間に新しい値は報告されませんでした。

デフォルトでは、累積 Sum タイプのメトリクスをエクスポートする、単一のアプリケーションから OpenTelemetry UpDownCounter インスツルメントを使用しているとします。次の表は、Datadog の動作をまとめたものです。

収集期間UpDownCounter 値OTLP Sum 値Datadog に報告される値Datadog アプリ内タイプ
#1[1,1,1,2,2,2,3,3]1515GAUGE
#2[3,-4,1,2]1717GAUGE
#3[-1]1616GAUGE

OpenTelemetry Gauge のインスツルメントである temperature を、単一のアプリケーションから使用しているとします。 次の表は、Datadog の動作をまとめたものです。

収集期間Gauge インスツルメントOTLP Gauge 値Datadog に報告される値Datadog アプリ内タイプ
#171.571.571.5GAUGE
#2727272GAUGE
#3707070GAUGE

OpenTelemetry Histogram インスツルメントである request.response_time.histogram を 2 つのウェブサーバーから使用しているとします。webserver:web_1webserver:web_2 です。ある収集期間において、 webserver:web_1[1,1,1,2,2,2,3,3] という値のメトリクスを報告し、 webserver:web_2[1,1,2] という値の同じメトリクスを報告しているとします。この収集期間中、次の 5 つの集計は、両方のウェブサーバーから収集されたすべての値のグローバルな統計的分布を表しています。

メトリクス名Datadog アプリ内タイプ
avg:request.response_time.distribution1.73GAUGE
count:request.response_time.distribution11COUNT
max:request.response_time.distribution3GAUGE
min:request.response_time.distribution1GAUGE
sum:request.response_time.distribution19COUNT

分布についてもっと読むと、さらなる集計の構成方法を理解できます。

また、counters モードを使用し、send_aggregation_metrics フラグを有効にし、ヒストグラムのバケットの境界を [-inf, 2, inf] とした場合、以下のメトリクスが報告されます。

メトリクス名タグDatadog アプリ内タイプ
request.response_time.distribution.count8非該当COUNT
request.response_time.distribution.sum15非該当COUNT
request.response_time.distribution.max3非該当GAUGE
request.response_time.distribution.min1非該当GAUGE
request.response_time.distribution.bucket6lower_bound:-infupper_bound:2GAUGE
request.response_time.distribution.bucket2lower_bound:2upper_bound:infGAUGE

レガシー OTLP Summary のメトリクス、request.response_time.summary をあるウェブサーバーから送信しているとします。ある収集期間において、ウェブサーバーは [1,1,1,2,2,3,3] という値でメトリクスを報告したとします。最小分位数、最大分位数、および中央値分位数が有効になっている場合、次のメトリクスが報告されます。

メトリクス名タグDatadog アプリ内タイプ
request.response_time.distribution.count8非該当COUNT
request.response_time.distribution.sum15非該当COUNT
request.response_time.distribution.quantile1quantile:0GAUGE
request.response_time.distribution.quantile2quantile:0.5GAUGE
request.response_time.distribution.quantile3quantile:1.0GAUGE

その他の参考資料