Keycloak-Exporter

Linux

Windows

Der Keycloak-Exporter dient zum Extrahieren von Statistiken und Zustandsinformationen aus Keycloak.

Konfiguration

Der Exporter wird über ein Service Provider Interface (SPI) bereitgestellt und kann hier heruntergeladen werden: GitHub - Keycloak Metrics SPI

Die Datei keycloak-metrics-spi.jar in das Keycloak-Verzeichnis [Pfad zum Keycloak]/providers/ ablegen.
Keycloak erneut starten.
SPI aktivieren im Keycloak in jedem Realm, für das Metriken geliefert werden sollen.
Hierzu in den Realm-Einstellungen auf Manage > Events > Config gehen und bei den Event-Listeners den metrics-Listener hinzufügen:

Die Metriken können nun über die folgende URL aufgerufen werden: https://[hostname]/auth/realms/[realm]/metrics

Unter einer URL sind die Daten für sämtliche Realms enthalten. Man kann hier also auch das Master-Realm aufrufen, selbst wenn gar kein Event-Listener konfiguriert wurde.

Exporter einrichten

Da der Exporter nicht unter [hostname]/metrics erreichbar ist, muss hier der metrics_path mit übergeben werden:

  - job_name: 'keycloak'
    metrics_path: /auth/realms/master/metrics
    static_configs:
        - targets: ['hostname']
          labels:
            instance: 'Keycloak Test'

Dashboard einrichten

Siehe Keycloak Metriken Dashboard

Security

Leider bietet das SPI keine Möglichkeit an, den Zugriff auf die Metriken von sich aus einzuschränken. Das heißt, per Default hat jeder Zugriff auf diese URL, der auch Zugriff auf Keycloak hat. Aus diesem Grund wird auch empfohlen, den Zugriff über einen Proxy einzuschränken.