search

aerogear / keycloak-metrics-spi

Adds a Metrics Endpoint to Keycloak
Apache License 2.0
551 stars 156 forks source link

Count users in keycloak_count_users metric #83

Open jermarchand opened 3 years ago

jermarchand commented 3 years ago

Motivation

Add a new metric which is a gauge of the total number of users on the Keycloak instance. https://github.com/aerogear/keycloak-metrics-spi/issues/81

What

Add 1 Gauge :

Why

Show the number of users

How

On REGISTER or CREATE/DELETE User events, count the users of the realm.

Verification Steps

Add the steps required to check this change. Following an example.

  1. Build the SPI from this branch and start Keycloak with it.
  2. Register a new user
  3. Add new user with admin-console
  4. Open the metrics endpoint in a browser.

Checklist:

Progress

Additional Notes

I'm a newby with Prometheus metrics, so fell free to comment and propose better implementation.

Until first REGISTER or CREATE/DELETE User events, the metric is not set.

pb82 commented 3 years ago

Thanks for the contribution @jermarchand , this looks reasonable to me

pb82 commented 3 years ago

@jermarchand this works as long as users are created or register through the UI. When using the API to create users (like e.g. the keycloak operator does) no register or create event is fired and the users are not counted. One solution would be to count the users on every regular and admin event. Not sure if this could lead to excessive database queries when scraping metrics often?

jermarchand commented 3 years ago

I don't know how operator work :/ If it use the "Registration flow" a user event "Register" is generated. If it use the Keycloak Admin REST API an admin event "CREATE USER" is generated.