Add missing event metrics from aerogear/keycloak-metrics-spi to a key…

…cloak mircometer event listener inspired by https://github.com/aerogear/keycloak-metrics-spi https://github.com/please-openit/keycloak-native-metrics https://github.com/thomasdarimont/keycloak-project-example/tree/main/keycloak/extensions/src/main/java/com/github/thomasdarimont/keycloak/custom/metrics fixes: keycloak#33043
bohmber · Oct 4, 2024 · 65d3b01 · 65d3b01
1 parent 85b1190
commit 65d3b01
Showing 1 changed file with 40 additions and 40 deletions.
diff --git a/.../keycloak/quarkus/runtime/services/metrics/events/MicrometerMetricsEventListenerTest.java b/.../keycloak/quarkus/runtime/services/metrics/events/MicrometerMetricsEventListenerTest.java
@@ -94,15 +94,15 @@ public void shouldCorrectlyCountLoginAndLoginError() {
             final Event login1 = createEvent(EventType.LOGIN, DEFAULT_REALM_NAME, "THE_CLIENT_ID");
             getMicrometerMetricsEventListener(session).onEvent(login1);
         });
-        assertMetric("keycloak.event", 1, "idp", "",
+        assertMetric("keycloak", 1, "idp", "",
                 "event", "login", "error", "", "client.id", "THE_CLIENT_ID", "realm", DEFAULT_REALM_NAME);
 
         KeycloakModelUtils.runJobInTransaction(keycloakSessionFactory, (KeycloakSession session) -> {
             // with LOGIN_ERROR event
             final Event event2 = createEvent(EventType.LOGIN_ERROR, DEFAULT_REALM_NAME, "THE_CLIENT_ID", "user_not_found");
             getMicrometerMetricsEventListener(session).onEvent(event2);
         });
-        assertMetric("keycloak.event", 1, "idp", "",
+        assertMetric("keycloak", 1, "idp", "",
                 "event", "login_error", "error", "user_not_found", "client.id", "THE_CLIENT_ID", "realm", DEFAULT_REALM_NAME);
     }
 
@@ -115,15 +115,15 @@ public void shouldCorrectlyCountLoginWhenIdentityProviderIsDefined() {
                     tuple(Details.IDENTITY_PROVIDER, "THE_ID_PROVIDER"));
             getMicrometerMetricsEventListener(session).onEvent(login1);
         });
-        assertMetric("keycloak.event", 1, "idp", "THE_ID_PROVIDER",
+        assertMetric("keycloak", 1, "idp", "THE_ID_PROVIDER",
                 "event", "login", "error", "", "client.id", "THE_CLIENT_ID", "realm", DEFAULT_REALM_NAME);
 
         KeycloakModelUtils.runJobInTransaction(keycloakSessionFactory, (KeycloakSession session) -> {
             final Event login2 = createEvent(EventType.LOGIN, DEFAULT_REALM_NAME, "THE_CLIENT_ID",
                     tuple(Details.IDENTITY_PROVIDER, "THE_ID_PROVIDER"));
             getMicrometerMetricsEventListener(session).onEvent(login2);
         });
-        assertMetric("keycloak.event", 2, "idp", "THE_ID_PROVIDER",
+        assertMetric("keycloak", 2, "idp", "THE_ID_PROVIDER",
                 "event", "login", "error", "", "client.id", "THE_CLIENT_ID", "realm", DEFAULT_REALM_NAME);
     }
 
@@ -134,14 +134,14 @@ public void shouldCorrectlyCountLoginWhenIdentityProviderIsNotDefined() {
             final Event login1 = createEvent(EventType.LOGIN);
             getMicrometerMetricsEventListener(session).onEvent(login1);
         });
-        assertMetric("keycloak.event", 1, "idp", "",
+        assertMetric("keycloak", 1, "idp", "",
                 "event", "login", "error", "", "client.id", "THE_CLIENT_ID", "realm", DEFAULT_REALM_NAME);
 
         KeycloakModelUtils.runJobInTransaction(keycloakSessionFactory, (KeycloakSession session) -> {
             final Event login2 = createEvent(EventType.LOGIN);
             getMicrometerMetricsEventListener(session).onEvent(login2);
         });
-        assertMetric("keycloak.event", 2, "idp", "",
+        assertMetric("keycloak", 2, "idp", "",
                 "event", "login", "error", "", "client.id", "THE_CLIENT_ID", "realm", DEFAULT_REALM_NAME);
     }
 
@@ -155,7 +155,7 @@ public void shouldCorrectlyCountLoginsFromDifferentProviders() {
             getMicrometerMetricsEventListener(session).onEvent(login1);
         });
 
-        assertMetric("keycloak.event", 1, "idp", "THE_ID_PROVIDER",
+        assertMetric("keycloak", 1, "idp", "THE_ID_PROVIDER",
                 "event", "login", "error", "", "client.id", "THE_CLIENT_ID", "realm", DEFAULT_REALM_NAME);
 
         KeycloakModelUtils.runJobInTransaction(keycloakSessionFactory, (KeycloakSession session) -> {
@@ -164,9 +164,9 @@ public void shouldCorrectlyCountLoginsFromDifferentProviders() {
             getMicrometerMetricsEventListener(session).onEvent(login2);
         });
 
-        assertMetric("keycloak.event", 1, "idp", "",
+        assertMetric("keycloak", 1, "idp", "",
                 "event", "login", "error", "", "client.id", "THE_CLIENT_ID", "realm", DEFAULT_REALM_NAME);
-        assertMetric("keycloak.event", 1, "idp", "THE_ID_PROVIDER",
+        assertMetric("keycloak", 1, "idp", "THE_ID_PROVIDER",
                 "event", "login", "error", "", "client.id", "THE_CLIENT_ID", "realm", DEFAULT_REALM_NAME);
     }
 
@@ -187,9 +187,9 @@ public void shouldCountLoginsPerRealm() {
             getMicrometerMetricsEventListener(session).onEvent(login2);
         });
 
-        assertMetric("keycloak.event", 1, "idp", "THE_ID_PROVIDER",
+        assertMetric("keycloak", 1, "idp", "THE_ID_PROVIDER",
                 "event", "login", "error", "", "client.id", "THE_CLIENT_ID", "realm", DEFAULT_REALM_NAME);
-        assertMetric("keycloak.event", 1, "idp", "THE_ID_PROVIDER",
+        assertMetric("keycloak", 1, "idp", "THE_ID_PROVIDER",
                 "event", "login", "error", "", "client.id", "THE_CLIENT_ID", "realm", "OTHER_REALM");
     }
 
@@ -203,7 +203,7 @@ public void shouldCorrectlyCountLoginError() {
                     tuple(Details.IDENTITY_PROVIDER, "THE_ID_PROVIDER"));
             getMicrometerMetricsEventListener(session).onEvent(event1);
         });
-        assertMetric("keycloak.event", 1, "idp", "THE_ID_PROVIDER",
+        assertMetric("keycloak", 1, "idp", "THE_ID_PROVIDER",
                 "event", "login_error", "error", "user_not_found", "client.id", "THE_CLIENT_ID", "realm", DEFAULT_REALM_NAME);
 
         KeycloakModelUtils.runJobInTransaction(keycloakSessionFactory, (KeycloakSession session) -> {
@@ -212,9 +212,9 @@ public void shouldCorrectlyCountLoginError() {
                     "THE_CLIENT_ID", "user_not_found");
             getMicrometerMetricsEventListener(session).onEvent(event2);
         });
-        assertMetric("keycloak.event", 1, "idp", "", "error", "user_not_found",
+        assertMetric("keycloak", 1, "idp", "", "error", "user_not_found",
                 "event", "login_error", "client.id", "THE_CLIENT_ID", "realm", DEFAULT_REALM_NAME);
-        assertMetric("keycloak.event", 1, "idp", "THE_ID_PROVIDER",
+        assertMetric("keycloak", 1, "idp", "THE_ID_PROVIDER",
                 "event", "login_error", "error", "user_not_found", "client.id", "THE_CLIENT_ID", "realm", DEFAULT_REALM_NAME);
     }
 
@@ -226,17 +226,17 @@ public void shouldCorrectlyCountRegister() {
                     tuple(Details.IDENTITY_PROVIDER, "THE_ID_PROVIDER"));
             getMicrometerMetricsEventListener(session).onEvent(event1);
         });
-        assertMetric("keycloak.event", 1, "idp", "THE_ID_PROVIDER",
+        assertMetric("keycloak", 1, "idp", "THE_ID_PROVIDER",
                 "event", "register", "error", "", "client.id", "THE_CLIENT_ID", "realm", DEFAULT_REALM_NAME);
 
         KeycloakModelUtils.runJobInTransaction(keycloakSessionFactory, (KeycloakSession session) -> {
             // without id provider defined
             final Event event2 = createEvent(EventType.REGISTER, DEFAULT_REALM_NAME, "THE_CLIENT_ID");
             getMicrometerMetricsEventListener(session).onEvent(event2);
         });
-        assertMetric("keycloak.event", 1, "idp", "",
+        assertMetric("keycloak", 1, "idp", "",
                 "event", "register", "error", "", "client.id", "THE_CLIENT_ID", "realm", DEFAULT_REALM_NAME);
-        assertMetric("keycloak.event", 1, "idp", "THE_ID_PROVIDER",
+        assertMetric("keycloak", 1, "idp", "THE_ID_PROVIDER",
                 "event", "register", "error", "", "client.id", "THE_CLIENT_ID", "realm", DEFAULT_REALM_NAME);
     }
 
@@ -249,7 +249,7 @@ public void shouldCorrectlyCountRefreshToken() {
             getMicrometerMetricsEventListener(session).onEvent(event1);
         });
 
-        assertMetric("keycloak.event", 1, "idp", "THE_ID_PROVIDER",
+        assertMetric("keycloak", 1, "idp", "THE_ID_PROVIDER",
                 "event", "refresh_token", "error", "", "client.id", "THE_CLIENT_ID", "realm", DEFAULT_REALM_NAME);
 
         KeycloakModelUtils.runJobInTransaction(keycloakSessionFactory, (KeycloakSession session) -> {
@@ -258,9 +258,9 @@ public void shouldCorrectlyCountRefreshToken() {
             getMicrometerMetricsEventListener(session).onEvent(event2);
         });
 
-        assertMetric("keycloak.event", 1, "idp", "",
+        assertMetric("keycloak", 1, "idp", "",
                 "event", "refresh_token", "error", "", "client.id", "THE_CLIENT_ID", "realm", DEFAULT_REALM_NAME);
-        assertMetric("keycloak.event", 1, "idp", "THE_ID_PROVIDER",
+        assertMetric("keycloak", 1, "idp", "THE_ID_PROVIDER",
                 "event", "refresh_token", "error", "", "client.id", "THE_CLIENT_ID", "realm", DEFAULT_REALM_NAME);
     }
 
@@ -274,7 +274,7 @@ public void shouldCorrectlyCountRefreshTokenError() {
             getMicrometerMetricsEventListener(session).onEvent(event1);
         });
 
-        assertMetric("keycloak.event", 1, "idp", "THE_ID_PROVIDER",
+        assertMetric("keycloak", 1, "idp", "THE_ID_PROVIDER",
                 "event", "refresh_token_error", "error", "user_not_found", "client.id", "THE_CLIENT_ID", "realm", DEFAULT_REALM_NAME);
 
         KeycloakModelUtils.runJobInTransaction(keycloakSessionFactory, (KeycloakSession session) -> {
@@ -283,9 +283,9 @@ public void shouldCorrectlyCountRefreshTokenError() {
             getMicrometerMetricsEventListener(session).onEvent(event2);
         });
 
-        assertMetric("keycloak.event", 1, "idp", "",
+        assertMetric("keycloak", 1, "idp", "",
                 "event", "refresh_token_error", "error", "user_not_found", "client.id", "THE_CLIENT_ID", "realm", DEFAULT_REALM_NAME);
-        assertMetric("keycloak.event", 1, "idp", "THE_ID_PROVIDER",
+        assertMetric("keycloak", 1, "idp", "THE_ID_PROVIDER",
                 "event", "refresh_token_error", "error", "user_not_found", "client.id", "THE_CLIENT_ID", "realm", DEFAULT_REALM_NAME);
     }
 
@@ -298,7 +298,7 @@ public void shouldCorrectlyCountClientLogin() {
             getMicrometerMetricsEventListener(session).onEvent(event1);
         });
 
-        assertMetric("keycloak.event", 1, "idp", "THE_ID_PROVIDER",
+        assertMetric("keycloak", 1, "idp", "THE_ID_PROVIDER",
                 "event", "client_login", "error", "", "client.id", "THE_CLIENT_ID", "realm", DEFAULT_REALM_NAME);
 
         KeycloakModelUtils.runJobInTransaction(keycloakSessionFactory, (KeycloakSession session) -> {
@@ -307,9 +307,9 @@ public void shouldCorrectlyCountClientLogin() {
             getMicrometerMetricsEventListener(session).onEvent(event2);
         });
 
-        assertMetric("keycloak.event", 1, "idp", "",
+        assertMetric("keycloak", 1, "idp", "",
                 "event", "client_login", "error", "", "client.id", "THE_CLIENT_ID", "realm", DEFAULT_REALM_NAME);
-        assertMetric("keycloak.event", 1, "idp", "THE_ID_PROVIDER",
+        assertMetric("keycloak", 1, "idp", "THE_ID_PROVIDER",
                 "event", "client_login", "error", "", "client.id", "THE_CLIENT_ID", "realm", DEFAULT_REALM_NAME);
     }
 
@@ -322,7 +322,7 @@ public void shouldCorrectlyCountClientLoginError() {
                     "user_not_found", tuple(Details.IDENTITY_PROVIDER, "THE_ID_PROVIDER"));
             getMicrometerMetricsEventListener(session).onEvent(event1);
         });
-        assertMetric("keycloak.event", 1, "idp", "THE_ID_PROVIDER",
+        assertMetric("keycloak", 1, "idp", "THE_ID_PROVIDER",
                 "event", "client_login_error", "error", "user_not_found", "client.id", "THE_CLIENT_ID", "realm", DEFAULT_REALM_NAME);
 
         KeycloakModelUtils.runJobInTransaction(keycloakSessionFactory, (KeycloakSession session) -> {
@@ -331,9 +331,9 @@ public void shouldCorrectlyCountClientLoginError() {
                     "THE_CLIENT_ID", "user_not_found");
             getMicrometerMetricsEventListener(session).onEvent(event2);
         });
-        assertMetric("keycloak.event", 1, "idp", "",
+        assertMetric("keycloak", 1, "idp", "",
                 "event", "client_login_error", "error", "user_not_found", "client.id", "THE_CLIENT_ID", "realm", DEFAULT_REALM_NAME);
-        assertMetric("keycloak.event", 1, "idp", "THE_ID_PROVIDER",
+        assertMetric("keycloak", 1, "idp", "THE_ID_PROVIDER",
                 "event", "client_login_error", "error", "user_not_found", "client.id", "THE_CLIENT_ID", "realm", DEFAULT_REALM_NAME);
     }
 
@@ -346,16 +346,16 @@ public void shouldCorrectlyCountCodeToToken() {
                     tuple(Details.IDENTITY_PROVIDER, "THE_ID_PROVIDER"));
             getMicrometerMetricsEventListener(session).onEvent(event1);
         });
-        assertMetric("keycloak.event", 1, "idp", "THE_ID_PROVIDER",
+        assertMetric("keycloak", 1, "idp", "THE_ID_PROVIDER",
                 "event", "code_to_token", "error", "", "client.id", "THE_CLIENT_ID", "realm", DEFAULT_REALM_NAME);
         KeycloakModelUtils.runJobInTransaction(keycloakSessionFactory, (KeycloakSession session) -> {
             // without id provider defined
             final Event event2 = createEvent(EventType.CODE_TO_TOKEN, DEFAULT_REALM_NAME, "THE_CLIENT_ID");
             getMicrometerMetricsEventListener(session).onEvent(event2);
         });
-        assertMetric("keycloak.event", 1, "idp", "",
+        assertMetric("keycloak", 1, "idp", "",
                 "event", "code_to_token", "error", "", "client.id", "THE_CLIENT_ID", "realm", DEFAULT_REALM_NAME);
-        assertMetric("keycloak.event", 1, "idp", "THE_ID_PROVIDER",
+        assertMetric("keycloak", 1, "idp", "THE_ID_PROVIDER",
                 "event", "code_to_token", "error", "", "client.id", "THE_CLIENT_ID", "realm", DEFAULT_REALM_NAME);
     }
 
@@ -368,7 +368,7 @@ public void shouldCorrectlyCountCodeToTokenError() {
                     "user_not_found", tuple(Details.IDENTITY_PROVIDER, "THE_ID_PROVIDER"));
             getMicrometerMetricsEventListener(session).onEvent(event1);
         });
-        assertMetric("keycloak.event", 1, "idp", "THE_ID_PROVIDER",
+        assertMetric("keycloak", 1, "idp", "THE_ID_PROVIDER",
                 "event", "code_to_token_error", "error", "user_not_found", "client.id", "THE_CLIENT_ID", "realm", DEFAULT_REALM_NAME);
 
         KeycloakModelUtils.runJobInTransaction(keycloakSessionFactory, (KeycloakSession session) -> {
@@ -377,9 +377,9 @@ public void shouldCorrectlyCountCodeToTokenError() {
                     "user_not_found");
             getMicrometerMetricsEventListener(session).onEvent(event2);
         });
-        assertMetric("keycloak.event", 1, "idp", "",
+        assertMetric("keycloak", 1, "idp", "",
                 "event", "code_to_token_error", "error", "user_not_found", "client.id", "THE_CLIENT_ID", "realm", DEFAULT_REALM_NAME);
-        assertMetric("keycloak.event", 1, "idp", "THE_ID_PROVIDER",
+        assertMetric("keycloak", 1, "idp", "THE_ID_PROVIDER",
                 "event", "code_to_token_error", "error", "user_not_found", "client.id", "THE_CLIENT_ID", "realm", DEFAULT_REALM_NAME);
     }
 
@@ -389,21 +389,21 @@ public void shouldCorrectlyCountGenericEvent() {
         KeycloakModelUtils.runJobInTransaction(keycloakSessionFactory, (KeycloakSession session) -> {
             getMicrometerMetricsEventListener(session).onEvent(event1);
         });
-        assertMetric("keycloak.simple.event", 1, "realm", DEFAULT_REALM_NAME,
+        assertMetric("keycloak.simple", 1, "realm", DEFAULT_REALM_NAME,
                 "event", "update_email");
         KeycloakModelUtils.runJobInTransaction(keycloakSessionFactory, (KeycloakSession session) -> {
             getMicrometerMetricsEventListener(session).onEvent(event1);
         });
-        assertMetric("keycloak.simple.event", 2, "realm", DEFAULT_REALM_NAME,
+        assertMetric("keycloak.simple", 2, "realm", DEFAULT_REALM_NAME,
                 "event", "update_email");
 
         final Event event2 = createEvent(EventType.REVOKE_GRANT_ERROR);
         KeycloakModelUtils.runJobInTransaction(keycloakSessionFactory, (KeycloakSession session) -> {
             getMicrometerMetricsEventListener(session).onEvent(event2);
         });
-        assertMetric("keycloak.simple.event", 1, "realm", DEFAULT_REALM_NAME,
+        assertMetric("keycloak.simple", 1, "realm", DEFAULT_REALM_NAME,
                 "event", "revoke_grant_error");
-        assertMetric("keycloak.simple.event", 2, "realm", DEFAULT_REALM_NAME,
+        assertMetric("keycloak.simple", 2, "realm", DEFAULT_REALM_NAME,
                 "event", "update_email");
     }
 
@@ -419,7 +419,7 @@ public void shouldTolerateNullLabels() {
 
             getMicrometerMetricsEventListener(session).onEvent(nullEvent);
         });
-        assertMetric("keycloak.event", 1, "idp", "",
+        assertMetric("keycloak", 1, "idp", "",
                 "event", "login_error", "error", "", "client.id", "", "realm", "");
     }