第3章 イベントメトリクスを使用してユーザーアクティビティーを監視する
イベントメトリクスは、Red Hat build of Keycloak インスタンス内のユーザーアクティビティーの集約ビューを提供します。
現時点では、ユーザーイベントのメトリクスのみがキャプチャーされます。たとえば、ログイン回数、ログイン失敗回数、実行されたトークンの更新回数などを監視できます。
メトリクスは標準メトリクスエンドポイントを使用して公開されます。それを独自のメトリクス収集システムで使用して、ダッシュボードやアラートを作成できます。
メトリクスは、Red Hat build of Keycloak インスタンスごとにカウンターとして報告されます。インスタンスを再起動すると、カウンターはリセットされます。クラスター内で複数のインスタンスが実行されている場合は、すべてのインスタンスからメトリクスを収集し、それらを集約してクラスタービューごとに取得する必要があります。
3.1. イベントメトリクスを有効にする リンクのコピーリンクがクリップボードにコピーされました!
イベントメトリクスの収集を開始するには、メトリクスを有効にし、ユーザーイベントのメトリクスを有効にします。
必要な起動パラメーターは次のとおりです。
bin/kc.[sh|bat] start --metrics-enabled=true --event-metrics-user-enabled=true ...
bin/kc.[sh|bat] start --metrics-enabled=true --event-metrics-user-enabled=true ...
デフォルトでは、レルムごとに個別のメトリクスが存在します。メトリクスをクライアントおよびアイデンティティープロバイダー別に分類するには、設定オプションの event-metrics-user-tags
を使用してメトリクスディメンションを追加できます。これは、クライアントと IDP の数が少ないインストールで役立ちます。しかし、Red Hat build of Keycloak のメモリー使用量、および監視システムの負荷が増加するため、多数のクライアントまたは IDP があるインストールには推奨されません。
以下は、メトリクスを 3 つのメトリクスディメンションすべてに分類するように Red Hat build of Keycloak を設定する方法を示しています。
bin/kc.[sh|bat] start ... --event-metrics-user-tags=realm,idp,clientId ...
bin/kc.[sh|bat] start ... --event-metrics-user-tags=realm,idp,clientId ...
Red Hat build of Keycloak がメトリクスを公開するイベントを制限できます。利用可能なイベントの概要は、イベントタイプに関するサーバー管理ガイド を参照してください。
次の例では、収集されるイベントを LOGIN
イベントと LOGOUT
イベントに制限します。
bin/kc.[sh|bat] start ... --event-metrics-user-events=login,logout ...
bin/kc.[sh|bat] start ... --event-metrics-user-events=login,logout ...
収集されるメトリクスの説明は、自己提供メトリクス を参照してください。