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