HTTPメトリクス

Keycloak HTTPリクエスト処理の監視用メトリクスについて学びます

前提条件

  • Keycloakでメトリクスを有効にする必要があります。詳細については、メトリクスによる洞察の獲得ガイドに従ってください。

  • メトリクスを収集する監視システム。

メトリクス

処理時間

処理時間はこれらのメトリクスによって公開され、Keycloakのパフォーマンスとリクエスト処理にかかる時間を監視します。

正常なクラスターでは、平均処理時間は安定しています。処理時間の急上昇または増加は、一部のノードが負荷を受けている兆候である可能性があります。

タグ

method

HTTPメソッド。

outcome

より一般的なoutcomeタグ。

status

HTTPステータスコード。

uri

リクエストされたURI。

メトリクス 説明

http_server_requests_seconds_count

処理されたリクエストの総数。

http_server_requests_seconds_sum

処理されたすべてのリクエストの合計時間。

http-metrics-histograms-enabledtrueに設定して、このメトリクスのヒストグラムを有効にできます。また、http-metrics-slosオプションを使用して、サービスレベル目標の追加バケットを追加できます。

ヒストグラムが有効になっている場合、パーセンタイルバケットが利用可能です。これらはヒートマップを作成し、レイテンシを分析するのに役立ちますが、パーセンタイルバケットを収集および公開すると、監視システムの負荷が増加します。

アクティブなリクエスト

現在のアクティブなリクエスト数も利用可能です。

メトリクス 説明

http_server_active_requests

現在のアクティブなリクエスト数

帯域幅

以下のメトリクスは、Keycloakで使用される帯域幅と消費トラフィック、および受信または送信されたリクエストとレスポンスによって消費されるトラフィックを監視するのに役立ちます。

メトリクス 説明

http_server_bytes_written_count

送信されたレスポンスの総数。

http_server_bytes_written_sum

送信されたバイト数の合計。

http_server_bytes_read_count

受信したリクエストの総数。

http_server_bytes_read_sum

受信したバイト数の合計。

ヒストグラムが有効になっている場合、パーセンタイルバケットが利用可能です。これらはヒートマップを作成し、レイテンシを分析するのに役立ちますが、パーセンタイルバケットを収集および公開すると、監視システムの負荷が増加します。

次のステップ

関連オプション

http-metrics-histograms-enabled

HTTPサーバーリクエストの期間のデフォルトバケットを持つヒストグラムを有効にします。

CLI: --http-metrics-histograms-enabled
Env: KC_HTTP_METRICS_HISTOGRAMS_ENABLED

メトリクスが有効になっている場合にのみ使用可能

true, false (デフォルト)

http-metrics-slos

HTTPサーバーリクエストのサービスレベル目標。

デフォルトのヒストグラムの代わりに使用するか、組み合わせて追加のバケットを追加します。ミリ秒単位で定義されたコンマ区切りの値のリストを指定します。5msから10秒のバケットの例:5,10,25,50,250,500,1000,2500,5000,10000

CLI: --http-metrics-slos
Env: KC_HTTP_METRICS_SLOS

メトリクスが有効になっている場合にのみ使用可能

このページについて