メトリクスエクスポーター - OTLP

この記事は英語の原文を日本語に翻訳したものです。原文: https://opentelemetry.io/docs/specs/otel/metrics/sdk_exporters/otlp/

翻訳元: open-telemetry/opentelemetry-specification v1.60.0(コミット 29ae8c7

ステータス: Stable

概要

OTLPメトリクスエクスポーターはPush Metric Exporterであり、OpenTelemetry Protocolを介してメトリクスを送信します。

OTLPメトリクスエクスポーターは、MetricReaderの出力temporalityをInstrument種別の関数として左右する設定をMUST提供するものとします。このオプションはtemporalityと名付けてもかまいません(MAY)が、デフォルトではすべてのInstrument種別についてtemporalityの優先設定をCumulativeにMUST設定するものとします。

OTLPメトリクスエクスポーターは、MetricReaderのデフォルトのaggregationをInstrument種別の関数として左右する設定をMUST提供するものとします。このオプションはdefault_aggregationと名付けてもかまいません(MAY)が、デフォルトではすべてのInstrument種別についてデフォルトの集約をMUST設定するものとします。

エクスポーターは、OpenTelemetry Protocol Exporter仕様に従った設定をMUST提供するものとします。

言語が、関連するエクスポーターと組み合わせるMetricReaderを自動的に設定する仕組み(例えばOTEL_METRICS_EXPORTER環境変数を使うなど)を提供している場合、デフォルトでは次のようになります。

  • エクスポーターはperiodic exporting MetricReaderとMUST組み合わされるものとします。
  • エクスポーターは、以下で説明するOTEL_EXPORTER_OTLP_METRICS_TEMPORALITY_PREFERENCE変数を使って、Instrument種別に基づいたデフォルトの集約temporalityをMUST設定するものとします。
  • エクスポーターは、それが実装されている場合、以下で説明するOTEL_EXPORTER_OTLP_METRICS_DEFAULT_HISTOGRAM_AGGREGATION変数を使って、Instrument種別に基づいたデフォルトの集約をMUST設定するものとします。

追加の環境変数設定

名前説明デフォルト
OTEL_EXPORTER_OTLP_METRICS_TEMPORALITY_PREFERENCEエクスポーターの集約temporalityオプション(上記参照)をInstrument種別に基づいて設定します。cumulativeEnum
OTEL_EXPORTER_OTLP_METRICS_DEFAULT_HISTOGRAM_AGGREGATIONエクスポーターのdefault_aggregationオプション(上記参照)をHistogram Instrument種別について設定します。explicit_bucket_histogramEnum

OTEL_EXPORTER_OTLP_METRICS_TEMPORALITY_PREFERENCEについて認識される値(大文字小文字を区別しない)は以下の通りです。

  • Cumulative: すべてのInstrument種別についてCumulative集約temporalityを選択します。
  • Delta: Counter、Asynchronous Counter、Histogramの各Instrument種別についてDelta集約temporalityを選択し、UpDownCounterとAsynchronous UpDownCounterの各Instrument種別についてCumulative集約を選択します。
  • LowMemory: この設定は、同期Counterと同期Histogramに対してDelta集約temporalityを使い、同期UpDownCounter、非同期Counter、非同期UpDownCounterの各Instrument種別に対してCumulative集約temporalityを使います。

「LowMemory」という選択肢は、特定の条件下でSDKが他の選択肢よりも少ないメモリを使えることからこのように名付けられています。比較すると、「cumulative」の選択肢はSDKに対して同期Counterと同期Histogramのdelta-to-cumulative変換の維持を強制し、一方「delta」の選択肢はSDKに対して非同期Counter Instrumentのcumulative-to-delta変換の維持を強制します。

OTEL_EXPORTER_OTLP_METRICS_DEFAULT_HISTOGRAM_AGGREGATIONについて認識される値(大文字小文字を区別しない)は以下の通りです。

参考文献