自己提供メトリクス

Keycloak が提供する主要なメトリクスについて学びます

これは「メトリクスを使用したトラブルシューティング」ガイドの一部です。

前提条件

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

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

メトリクス

ユーザーイベントメトリクス

ユーザーイベントメトリクスはデフォルトで無効になっています。有効にする方法と、記録するタグを設定する方法については、「イベントメトリクスによるユーザーアクティビティの監視」を参照してください。

メトリクス 説明

keycloak_user_events_total

ユーザーイベントの発生回数をカウントします。

タグ

タグ client_id および idp は、カーディナリティが高くなりすぎるのを避けるために、デフォルトで無効になっています。

realm

レルム

client_id

クライアント ID

idp

アイデンティティプロバイダー

event

ユーザーイベント(例:loginlogout)。利用可能なイベントの概要については、「イベントタイプに関するサーバー管理ガイド」を参照してください。

error

イベントに固有のエラー。たとえば、イベント login の場合は invalid_user_credentials。エラーが発生しなかった場合は空の文字列。

以下のスニペットは、メトリクスエンドポイントによって提供されるレスポンスの例です。

# HELP keycloak_user_events_total Keycloak user events
# TYPE keycloak_user_events_total counter
keycloak_user_events_total{client_id="security-admin-console",error="",event="code_to_token",idp="",realm="master",} 1.0
keycloak_user_events_total{client_id="security-admin-console",error="",event="login",idp="",realm="master",} 1.0
keycloak_user_events_total{client_id="security-admin-console",error="",event="logout",idp="",realm="master",} 1.0
keycloak_user_events_total{client_id="security-admin-console",error="invalid_user_credentials",event="login",idp="",realm="master",} 1.0

パスワードハッシュ

メトリクス 説明

keycloak_credentials_password_hashing_validations_total

パスワードハッシュの検証回数をカウントします。

タグ

realm

レルム

algorithm

パスワードのハッシュに使用されるアルゴリズム(例:argon2

hashing_strength

ハッシュアルゴリズムの強度を示す文字列。たとえば、アルゴリズムに依存する反復回数。例:Argon2id-1.3[m=7168,t=5,p=1]

outcome

パスワード検証の結果。取りうる値

valid

パスワードが正しい

invalid

パスワードが正しくない

error

パスワードのハッシュ作成時のエラー

利用可能なタグを設定するには、次のオプション spi-credential-keycloak-password-validations-counter-tags にタグ名をカンマ区切りで指定します。デフォルトでは、すべてのタグが有効になっています。

以下のスニペットは、メトリクスエンドポイントによって提供されるレスポンスの例です。

# HELP keycloak_credentials_password_hashing_validations_total Password validations
# TYPE keycloak_credentials_password_hashing_validations_total counter
keycloak_credentials_password_hashing_validations_total{algorithm="argon2",hashing_strength="Argon2id-1.3[m=7168,t=5,p=1]",outcome="valid",realm="realm-0",} 39949.0

次のステップ

メトリクスを使用したトラブルシューティング」に戻るか、「JVM メトリクス」に進んでください。

このページについて