Stephan Schnabel
c8977d7175
* First draft of implementation Readme will follow * Rename id. * Exclude `commons-io` to disable build warnings * Simplify metrics and add documentation
4 KiB
4 KiB
Keycloak Event Metrics
Provides metrics for Keycloak user/admin events.
What?
Resuses micrometer from Quarkus distribution to add metrics for Keycloak for events.
User Events
User events are added with key keycloak_event_user_total and tags:
type: EventType from Event#typerealm: realm id from Event#realmIdclient: client id from Event#clientIderror: error from Event#error, only present for error types
Examples:
keycloak_event_user_total{client="test",realm="9039a0b5-e8c9-437a-a02e-9d91b04548a4",type="LOGIN",error="",} 2.0
keycloak_event_user_total{client="test",realm="1fdb3465-1675-49e8-88ad-292e2f42ee72",type="LOGIN",error="",} 1.0
keycloak_event_user_total{client="test",realm="1fdb3465-1675-49e8-88ad-292e2f42ee72",type="LOGIN_ERROR",error="invalid_user_credentials",} 1.0
Admin Events
Admin events are added with key keycloak_event_admin_total and tags:
realm: realm id from AdminEvent#realmIdoperation: OperationType from AdminEvent#operationTyperesource: ResourceType from AdminEvent#resourceTypeerror: error from AdminEvent#error, only present for error types
Examples:
keycloak_event_admin_total{error="",operation="CREATE",realm="1fdb3465-1675-49e8-88ad-292e2f42ee72",resource="USER",} 1.0
keycloak_event_admin_total{error="",operation="CREATE",realm="9039a0b5-e8c9-437a-a02e-9d91b04548a4",resource="USER",} 1.0
Installation
Testcontainers
For usage in Testcontainers see KeycloakExtension.java
Docker
Dockerfile:
FROM quay.io/keycloak/keycloak:21.0.1
ENV KEYCLOAK_ADMIN=admin
ENV KEYCLOAK_ADMIN_PASSWORD=password
ENV KC_HEALTH_ENABLED=true
ENV KC_METRICS_ENABLED=true
ENV KC_LOG_CONSOLE_COLOR=true
ADD target/keycloak-event-metrics-0.0.1-SNAPSHOT.jar /opt/keycloak/providers
RUN /opt/keycloak/bin/kc.sh build
Run:
docker build . --tag keycloak:metrics
docker run --rm -p8080 keycloak:metrics start-dev