kokuwaio/keycloak-event-metrics
kokuwaio/keycloak-event-metrics
1
0
Fork 0
Code Issues 1 Pull requests Releases 7 Activity

Collect all unknown client ids as UNKNOWN. Fix #100

Browse source
This commit is contained in:
Stephan Schnabel 2024-12-02 17:22:27 +01:00
parent 7aeb1b9e25
commit b4fad32161
Signed by: stephan.schnabel
GPG key ID: E07AF5BA239FE543
5 changed files with 46 additions and 11 deletions
Download patch file Download diff file Expand all files Collapse all files

16
src/test/java/io/kokuwa/keycloak/metrics/KeycloakIT.java
View file

@ -48,6 +48,9 @@ public class KeycloakIT {
keycloak.createClient(realmName2, clientId2);
keycloak.createUser(realmName2, username2, password2);
var clientId3 = realmName2 + "_" + UUID.randomUUID();
var clientId4 = realmName2 + "_" + UUID.randomUUID();
prometheus.scrap();
var loginBefore = prometheus.userEvent(EventType.LOGIN);
var loginBefore1 = prometheus.userEvent(EventType.LOGIN, realmName1, clientId1);
@ -55,10 +58,13 @@ public class KeycloakIT {
var loginErrorBefore = prometheus.userEvent(EventType.LOGIN_ERROR);
var loginErrorBefore1 = prometheus.userEvent(EventType.LOGIN_ERROR, realmName1, clientId1);
var loginErrorBefore2 = prometheus.userEvent(EventType.LOGIN_ERROR, realmName2, clientId2);
var loginErrorBeforeUNKNOWN = prometheus.userEvent(EventType.LOGIN_ERROR, realmName2, "UNKNOWN");
assertDoesNotThrow(() -> keycloak.login(clientId1, realmName1, username1, password1));
assertDoesNotThrow(() -> keycloak.login(clientId1, realmName1, username1, password1));
assertDoesNotThrow(() -> keycloak.login(clientId2, realmName2, username2, password2));
assertThrows(NotAuthorizedException.class, () -> keycloak.login(clientId3, realmName2, "nope", "nö"));
assertThrows(NotAuthorizedException.class, () -> keycloak.login(clientId4, realmName2, "foo", "bar"));
assertThrows(NotAuthorizedException.class, () -> keycloak.login(clientId2, realmName2, username2, "nope"));
prometheus.scrap();
@ -68,14 +74,20 @@ public class KeycloakIT {
var loginErrorAfter = prometheus.userEvent(EventType.LOGIN_ERROR);
var loginErrorAfter1 = prometheus.userEvent(EventType.LOGIN_ERROR, realmName1, clientId1);
var loginErrorAfter2 = prometheus.userEvent(EventType.LOGIN_ERROR, realmName2, clientId2);
var loginErrorAfter3 = prometheus.userEvent(EventType.LOGIN_ERROR, realmName2, clientId3);
var loginErrorAfter4 = prometheus.userEvent(EventType.LOGIN_ERROR, realmName2, clientId4);
var loginErrorAfterUNKNOWN = prometheus.userEvent(EventType.LOGIN_ERROR, realmName2, "UNKNOWN");
assertAll("prometheus",
() -> assertEquals(loginBefore + 3, loginAfter, "login success total"),
() -> assertEquals(loginBefore1 + 2, loginAfter1, "login success #1"),
() -> assertEquals(loginBefore2 + 1, loginAfter2, "login success #2"),
() -> assertEquals(loginErrorBefore + 1, loginErrorAfter, "login failure total"),
() -> assertEquals(loginErrorBefore + 3, loginErrorAfter, "login failure total"),
() -> assertEquals(loginErrorBefore1 + 0, loginErrorAfter1, "login failure #1"),
() -> assertEquals(loginErrorBefore2 + 1, loginErrorAfter2, "login failure #2"));
() -> assertEquals(loginErrorBefore2 + 1, loginErrorAfter2, "login failure #2"),
() -> assertEquals(0, loginErrorAfter3, "login failure #3"),
() -> assertEquals(0, loginErrorAfter4, "login failure #4"),
() -> assertEquals(loginErrorBeforeUNKNOWN + 2 , loginErrorAfterUNKNOWN, "login failure UNKNOWN"));
}
@DisplayName("user count")

21
src/test/java/io/kokuwa/keycloak/metrics/event/MetricsEventListenerTest.java
View file

@ -13,6 +13,7 @@ import org.keycloak.events.EventType;
import org.keycloak.events.admin.AdminEvent;
import org.keycloak.events.admin.OperationType;
import org.keycloak.events.admin.ResourceType;
import org.keycloak.models.ClientModel;
import org.keycloak.models.KeycloakContext;
import org.keycloak.models.KeycloakSession;
import org.keycloak.models.RealmModel;
@ -37,6 +38,8 @@ public class MetricsEventListenerTest extends AbstractMockitoTest {
@Mock
RealmProvider realmProvider;
@Mock
ClientModel clientModel;
@Mock
KeycloakContext context;
@DisplayName("onEvent(true)")
@ -54,8 +57,10 @@ public class MetricsEventListenerTest extends AbstractMockitoTest {
when(session.getContext()).thenReturn(context);
when(context.getRealm()).thenReturn(realmModel);
when(context.getClient()).thenReturn(clientModel);
when(realmModel.getId()).thenReturn(realmId);
when(realmModel.getName()).thenReturn(realmName);
when(clientModel.getClientId()).thenReturn(clientId);
listener(true).onEvent(toEvent(realmId, clientId, type, null));
assertEvent(realmName, clientId, type.toString(), "");
@ -73,8 +78,10 @@ public class MetricsEventListenerTest extends AbstractMockitoTest {
when(session.getContext()).thenReturn(context);
when(context.getRealm()).thenReturn(realmModel);
when(context.getClient()).thenReturn(clientModel);
when(realmModel.getId()).thenReturn(realmId);
when(realmModel.getName()).thenReturn(realmName);
when(clientModel.getClientId()).thenReturn(clientId);
listener(true).onEvent(toEvent(realmId, clientId, type, error));
assertEvent(realmName, clientId, type.toString(), error);
@ -91,7 +98,7 @@ public class MetricsEventListenerTest extends AbstractMockitoTest {
when(realmModel.getName()).thenReturn(realmName);
listener(true).onEvent(toEvent(null, null, null, null));
assertEvent(realmName, "", "", "");
assertEvent(realmName, "UNKNOWN", "", "");
}
@DisplayName("replace(true) - context is null")
@ -108,7 +115,7 @@ public class MetricsEventListenerTest extends AbstractMockitoTest {
when(realmModel.getName()).thenReturn(realmName);
listener(true).onEvent(toEvent(realmId, clientId, type, null));
assertEvent(realmName, clientId, type.toString(), "");
assertEvent(realmName, "UNKNOWN", type.toString(), "");
}
@DisplayName("replace(true) - context is empty")
@ -126,7 +133,7 @@ public class MetricsEventListenerTest extends AbstractMockitoTest {
when(realmModel.getName()).thenReturn(realmName);
listener(true).onEvent(toEvent(realmId, clientId, type, null));
assertEvent(realmName, clientId, type.toString(), "");
assertEvent(realmName, "UNKNOWN", type.toString(), "");
}
@DisplayName("replace(true) - realmId is unknown")
@ -140,7 +147,9 @@ public class MetricsEventListenerTest extends AbstractMockitoTest {
when(session.getContext()).thenReturn(context);
when(session.realms()).thenReturn(realmProvider);
when(context.getRealm()).thenReturn(realmModel);
when(context.getClient()).thenReturn(clientModel);
when(realmModel.getId()).thenReturn(UUID.randomUUID().toString());
when(clientModel.getClientId()).thenReturn(clientId);
listener(true).onEvent(toEvent(realmId, clientId, type, null));
assertEvent(realmId, clientId, type.toString(), "");
@ -155,7 +164,7 @@ public class MetricsEventListenerTest extends AbstractMockitoTest {
var type = EventType.LOGIN;
listener(false).onEvent(toEvent(realmId, clientId, type, null));
assertEvent(realmId, clientId, type.toString(), "");
assertEvent(realmId, "UNKNOWN", type.toString(), "");
}
@DisplayName("replace(false) - with error")
@ -168,14 +177,14 @@ public class MetricsEventListenerTest extends AbstractMockitoTest {
var error = UUID.randomUUID().toString();
listener(false).onEvent(toEvent(realmId, clientId, type, error));
assertEvent(realmId, clientId, type.toString(), error);
assertEvent(realmId, "UNKNOWN", type.toString(), error);
}
@DisplayName("replace(false) - all fields empty")
@Test
void notReplaceFieldsEmpty() {
listener(false).onEvent(toEvent(null, null, null, null));
assertEvent("", "", "", "");
assertEvent("", "UNKNOWN", "", "");
}
private Event toEvent(String realmId, String clientId, EventType type, String error) {