kokuwaio/keycloak-event-metrics
kokuwaio/keycloak-event-metrics
1
0
Fork 0
Code Issues 1 Pull requests Releases 7 Activity
Provides metrics for Keycloak events
21 commits 1 branch 7 tags 982 KiB
Find a file
dependabot[bot] 7985958376
Bump keycloak-parent from 21.0.1 to 21.0.2 (#18) 
Bumps [keycloak-parent](https://github.com/keycloak/keycloak) from 21.0.1 to 21.0.2.
- [Release notes](https://github.com/keycloak/keycloak/releases)
- [Commits](https://github.com/keycloak/keycloak/compare/21.0.1...21.0.2)

---
updated-dependencies:
- dependency-name: org.keycloak:keycloak-parent
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
2023-04-06 07:19:42 +00:00
.github Increase pull request limit for dependency updates (#17) 2023-04-06 09:17:22 +02:00
src Remove unnecessary event spi (#9) (#10) 2023-03-20 08:55:56 +01:00
.markdownlint.yaml First draft of implementation (#1) 2023-03-03 12:38:06 +01:00
.yamllint First draft of implementation (#1) 2023-03-03 12:38:06 +01:00
LICENSE First draft of implementation (#1) 2023-03-03 12:38:06 +01:00
pom.xml Bump keycloak-parent from 21.0.1 to 21.0.2 (#18) 2023-04-06 07:19:42 +00:00
README.md Add why section to readme (#7) 2023-03-13 08:29:20 +00:00

README.md

Keycloak Event Metrics

Provides metrics for Keycloak user/admin events.

Apache License, Version 2.0, January 2004 Maven Central CI

Why?

aerogear/keycloak-metrics-spi is an alternative to this plugin but is not well maintained. This implementation is different:

  • no Prometheus push (event listener only adds counter to Micrometer)
  • no realm specific Prometheus endpoint, only /metrics (from Quarkus)
  • no jvm/http metrics, this is already included in Keycloak
  • different metric names, can relace model ids with name (see configuration)
  • deployed to maven central and very small (10 kb vs. 229 KB aerogear/keycloak-metrics-spi)

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:

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:

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

Configuration

KC_METRICS_EVENT_REPLACE_IDS

If set to true than replace model ids with names:

Metrics:

keycloak_event_user_total{client="test-client",error="",realm="test-realm",type="LOGIN",} 2.0
keycloak_event_user_total{client="other-client",error="",realm="other-realm",type="LOGIN",} 1.0
keycloak_event_user_total{client="other-client",error="invalid_user_credentials",realm="other-realm",type="LOGIN_ERROR",} 1.0

Installation

Testcontainers

For usage in Testcontainers see KeycloakExtension.java

Docker

Check: kokuwaio/keycloak

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