Monitoring user activities with event metrics
Saat ini, hanya metrik untuk event pengguna yang ditangkap. Misalnya, Anda dapat memantau jumlah login, kegagalan login, atau pembaruan token yang dilakukan.
Metrik tersebut diekspos melalui endpoint metrik standar, dan Anda dapat menggunakannya dalam sistem koleksi metrik Anda sendiri untuk membuat dasbor dan notifikasi.
Metrik tersebut dilaporkan sebagai penghitung per instance NQRust-Identity. Penghitung tersebut akan mereset saat instance dimulai ulang. Jika Anda memiliki beberapa instance yang berjalan di dalam sebuah cluster, Anda akan perlu mengumpulkan metrik dari semua instance dan mengagregasikannya untuk mendapatkan tampilan per cluster.
Mengaktifkan metrik event
Untuk mulai mengumpulkan metrik event, aktifkan metrik dan aktifkan metrik untuk event pengguna.
Berikut menunjukkan parameter startup yang diperlukan:
bin/kc.[sh|bat] start --metrics-enabled=true --event-metrics-user-enabled=true ...Secara default, ada metrik terpisah untuk setiap realm.
Untuk memecah metrik berdasarkan client dan penyedia identitas, Anda dapat menambahkan dimensi metrik tersebut menggunakan opsi konfigurasi event-metrics-user-tags.
Hal ini dapat berguna pada instalasi dengan jumlah client dan IDP yang sedikit.
Hal ini tidak disarankan untuk instalasi dengan jumlah client atau IDP yang banyak karena akan meningkatkan penggunaan memori NQRust-Identity dan juga akan meningkatkan beban pada sistem monitoring Anda.
Berikut menunjukkan bagaimana mengonfigurasi NQRust-Identity untuk memecah metrik berdasarkan semua tiga dimensi metrik:
bin/kc.[sh|bat] start ... --event-metrics-user-tags=realm,idp,clientId ...Anda dapat membatasi event untuk mana NQRust-Identity akan mengekspos metrik.
Contoh berikut membatasi event yang dikumpulkan ke event LOGIN dan LOGOUT:
bin/kc.[sh|bat] start ... --event-metrics-user-events=login,logout ...Opsi yang relevan
| Opsi | Tipe atau Nilai | Default |
|---|---|---|
metrics-enabledApakah server harus mengekspos metrik. Jika diaktifkan, metrik tersedia di endpoint /metrics.CLI: --metrics-enabledEnv: KC_METRICS_ENABLED | true, false | false |
event-metrics-user-enabledBuat metrik berdasarkan event pengguna. CLI: --event-metrics-user-enabledEnv: KC_EVENT_METRICS_USER_ENABLED | true, false | false |
event-metrics-user-eventsDaftar nilai yang dipisahkan koma dari event yang akan dikumpulkan untuk metrik event pengguna. Opsi ini dapat digunakan untuk mengurangi jumlah metrik yang dibuat karena secara default semua event pengguna membuat metrik. CLI: --event-metrics-user-eventsEnv: KC_EVENT_METRICS_USER_EVENTS | authreqid_to_token, client_delete, client_info, client_initiated_account_linking, client_login, client_register, client_update, code_to_token, custom_required_action, delete_account, execute_action_token, execute_actions, federated_identity_link, federated_identity_override_link, grant_consent, identity_provider_first_login, identity_provider_link_account, identity_provider_login, identity_provider_post_login, identity_provider_response, identity_provider_retrieve_token, impersonate, introspect_token, invalid_signature, invite_org, jwt_authorization_grant, login, logout, oauth2_device_auth, oauth2_device_code_to_token, oauth2_device_verify_user_code, oauth2_extension_grant, permission_token, pushed_authorization_request, refresh_token, register, register_node, remove_credential, remove_federated_identity, remove_totp (deprecated), reset_password, restart_authentication, revoke_grant, send_identity_provider_link, send_reset_password, send_verify_email, token_exchange, unregister_node, update_consent, update_credential, update_email, update_password (deprecated), update_profile, update_totp (deprecated), user_disabled_by_permanent_lockout, user_disabled_by_temporary_lockout, user_info_request, user_session_deleted, verifiable_credential_create_offer, verifiable_credential_nonce_request, verifiable_credential_offer_request, verifiable_credential_pre_authorized_grant, verifiable_credential_request, verify_email, verify_profile | |
event-metrics-user-tagsDaftar nilai yang dipisahkan koma dari tag yang akan dikumpulkan untuk metrik event pengguna. Secara default hanya realm yang diaktifkan untuk menghindari metrik cardinality yang tinggi.CLI: --event-metrics-user-tagsEnv: KC_EVENT_METRICS_USER_TAGS | realm, idp, clientId | realm |