メトリックの型 - Prometheusドキュメント

このページはPrometheus公式ドキュメント和訳+αの一部です。

METRIC TYPES

Prometheusクライアントライブラリは、4つのメトリック型を提供している。 これらは、現在は、クライアントライブラリの中で(それらの特定の型の利用方法に応じたAPIを可能にするため)、および通信プロトコルの中でのみ区別されている。 Prometheusサーバーは、型情報をまだ利用しておらず、全てのデータを型なしの時系列データに押しつぶしている。 これは、将来的には変更されるかもしれない。

Counter

カウンターは、累積的なメトリクスであり、単一の単調増加するカウンターであり、その値は増加させるか起動時にゼロにリセットすることしかできない。 例えば、カウンターは、応答したリクエスト数、完了したタスクの数、エラーの数などに利用できる。

減少することがありうる値を出力するためにカウンターを使わないこと。 例えば、実行中のプロセス数にはカウンターを使わず、ゲージを使うこと。

クライアントライブラリのカウンターの利用方法ドキュメントは以下の通り。

Gauge

ゲージは、自由に増加したり減少しうる単一の数値を表すメトリックである。

ゲージは、典型的には温度やメモリ使用量のような計測値に利用されるが、同時リクエスト数のような増えたり減ったりするカウントにも利用される。

クライアントライブラリのゲージの利用方法ドキュメントは以下の通り。

Histogram

ヒストグラムは、観測値(通常はリクエスト持続時間やレスポンスサイズのようなもの)のサンプリングをし、設定可能なバケット毎にカウントする。 全ての観測値の合計も提供する。

基本となるメトリック名が<basename>ヒストグラムは、以下のような複数の時系列を出力する。

  • 観測値のバケット毎の累積カウントを<basename>_bucket{le="<upper inclusive bound>"}として出力する
  • 全ての観測値の合計を<basename>_sumとして出力する
  • 観測されたイベント数を<basename>_countとして出力する(上記の<basename>_bucket{le="+Inf"}と同じ)

ヒストグラムや集約されたヒストグラムから分位数(quantile)を計算するには、histogram_quantile()を利用する。 ヒストグラムは、Apdex scoreを計算するのにも適している。 バケットを処理する際には、ヒストグラムが累積的であることを忘れずに。 ヒストグラムの利用方法およびサマリーとの違いの詳細に関しては、ヒストグラムとサマリーを参照すること。

クライアントライブラリのヒストグラムの利用方法ドキュメントは以下の通り。

Summary

サマリーは、ヒストグラムと同様に、観測値(通常はリクエスト持続時間やレスポンスサイズのようなもの)のサンプリングをする。観測の全カウントおよび観測値の合計を提供すると同時に、設定可能な分位数を計算する。

基本となるメトリック名が<basename>のサマリーは、以下のような複数の時系列を出力する。

  • 観測されたイベントのφ分位数(0 ≤ φ ≤ 1)を<basename>{quantile="<φ>"}として出力する
  • 全ての観測値の合計を<basename>_sumとして出力する
  • 観測されたイベントの数を<basename>_countとして出力する

φ分位数やサマリーの利用方法、ヒストグラムとの違いの詳細な説明については、ヒストグラムとサマリーを参照すること。

クライアントライブラリのサマリーの利用方法ドキュメントは以下の通り。

参考リンク

和訳活動の支援

Prometheusドキュメント和訳が役に立った方は、以下QRコードからPayPayで活動を支援して頂けるとありがたいです。

PayPayによる支援用QRコード
上のQRコードからPayPayによる支援
入門 Prometheus ―インフラとアプリケーションのパフォーマンスモニタリング

入門 Prometheus ―インフラとアプリケーションのパフォーマンスモニタリング

 
Prometheus: Up & Running: Infrastructure and Application Performance Monitoring

Prometheus: Up & Running: Infrastructure and Application Performance Monitoring

 
入門 監視 ―モダンなモニタリングのためのデザインパターン

入門 監視 ―モダンなモニタリングのためのデザインパターン

 
SRE サイトリライアビリティエンジニアリング ―Googleの信頼性を支えるエンジニアリングチーム

SRE サイトリライアビリティエンジニアリング ―Googleの信頼性を支えるエンジニアリングチーム