9.4. Prometheus に公開される 3scale APIcast メトリクス

3scale APIcast の監視用に Prometheus を設定すると、デフォルトでは 表9.2「3scale APIcast 用 Prometheus のデフォルトメトリクス」に記載されたメトリクスを監視することができます。

表9.3「3scale APIcast Batch ポリシー用 Prometheus メトリクス」に記載されたメトリクスは、「3scale Batcher」を使用する場合にのみ利用することができます。

表9.2 3scale APIcast 用 Prometheus のデフォルトメトリクス

メトリクス説明タイプラベル

nginx_http_connections

HTTP 接続の数

ゲージ

state (accepted、active、handled、reading、total、waiting、writing)

nginx_error_log

APIcast エラー

カウンター

level (debug、info、notice、warn、error、crit、alert、emerg)

openresty_shdict_capacity

ワーカー間で共有されるディクショナリーの容量

ゲージ

dict (すべてのディクショナリーで共通)

openresty_shdict_free_space

ワーカー間で共有されるディクショナリーの空き容量

ゲージ

dict (すべてのディクショナリーで共通)

nginx_metric_errors_total

メトリクスを管理する Lua ライブラリーのエラーの数

カウンター

none

total_response_time_seconds

クライアントにレスポンスを送信するのに必要な時間 (秒単位)

注記： service_id および service_system_name ラベルにアクセスするためには、「APIcast と Prometheus のインテグレーション」 に記載されているように APICAST_EXTENDED_METRICS 環境変数を true に設定する必要があります。

ヒストグラム

service_id、service_system_name

upstream_response_time_seconds

アップストリームサーバーからの応答時間 (秒単位)

注記： service_id および service_system_name ラベルにアクセスするためには、「APIcast と Prometheus のインテグレーション」 に記載されているように APICAST_EXTENDED_METRICS 環境変数を true に設定する必要があります。

ヒストグラム

service_id、service_system_name

upstream_status

アップストリームサーバーからの HTTP ステータス

注記： service_id および service_system_name ラベルにアクセスするためには、「APIcast と Prometheus のインテグレーション」 に記載されているように APICAST_EXTENDED_METRICS 環境変数を true に設定する必要があります。

counter

status、service_id、service_system_name

threescale_backend_calls

3scale バックエンド (Apisonator) に対する承認および報告リクエスト

カウンター

endpoint (authrep、auth、report)、status (2xx、4xx、5xx)

表9.3 3scale APIcast Batch ポリシー用 Prometheus メトリクス

メトリクス説明タイプラベル

batching_policy_auths_cache_hits

3scale Batcher ポリシーの承認キャッシュのヒット数

カウンター

none

batching_policy_auths_cache_misses

3scale Batcher ポリシーの承認キャッシュのミス数

カウンター

none