Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Using realmName instead of realmId from Event and AdminEvent #2

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Using realmName instead of realmId from Event and AdminEvent #2

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 14 additions & 16 deletions src/main/java/it/pleaseopen/keycloak/metrics/MetricsEventListener.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,17 +4,15 @@
import org.keycloak.events.Event;
import org.keycloak.events.EventListenerProvider;
import org.keycloak.events.admin.AdminEvent;
import org.keycloak.models.RealmProvider;

public class MetricsEventListener implements EventListenerProvider {

public final static String ID = "native-metrics-listener";

private final static Logger logger = Logger.getLogger(MetricsEventListener.class);
private final RealmProvider realmProvider;

public MetricsEventListener(RealmProvider realmProvider) {
this.realmProvider = realmProvider;
public MetricsEventListener() {

}

@Override
Expand All @@ -23,45 +21,45 @@ public void onEvent(Event event) {

switch (event.getType()) {
case LOGIN:
PrometheusExporter.instance().recordLogin(event, realmProvider);
PrometheusExporter.instance().recordLogin(event);
break;
case CLIENT_LOGIN:
PrometheusExporter.instance().recordClientLogin(event, realmProvider);
PrometheusExporter.instance().recordClientLogin(event);
break;
case REGISTER:
PrometheusExporter.instance().recordRegistration(event, realmProvider);
PrometheusExporter.instance().recordRegistration(event);
break;
case REFRESH_TOKEN:
PrometheusExporter.instance().recordRefreshToken(event, realmProvider);
PrometheusExporter.instance().recordRefreshToken(event);
break;
case CODE_TO_TOKEN:
PrometheusExporter.instance().recordCodeToToken(event, realmProvider);
PrometheusExporter.instance().recordCodeToToken(event);
break;
case REGISTER_ERROR:
PrometheusExporter.instance().recordRegistrationError(event, realmProvider);
PrometheusExporter.instance().recordRegistrationError(event);
break;
case LOGIN_ERROR:
PrometheusExporter.instance().recordLoginError(event, realmProvider);
PrometheusExporter.instance().recordLoginError(event);
break;
case CLIENT_LOGIN_ERROR:
PrometheusExporter.instance().recordClientLoginError(event, realmProvider);
PrometheusExporter.instance().recordClientLoginError(event);
break;
case REFRESH_TOKEN_ERROR:
PrometheusExporter.instance().recordRefreshTokenError(event, realmProvider);
PrometheusExporter.instance().recordRefreshTokenError(event);
break;
case CODE_TO_TOKEN_ERROR:
PrometheusExporter.instance().recordCodeToTokenError(event, realmProvider);
PrometheusExporter.instance().recordCodeToTokenError(event);
break;
default:
PrometheusExporter.instance().recordGenericEvent(event, realmProvider);
PrometheusExporter.instance().recordGenericEvent(event);
}
}

@Override
public void onEvent(AdminEvent event, boolean includeRepresentation) {
logAdminEventDetails(event);

PrometheusExporter.instance().recordGenericAdminEvent(event, realmProvider);
PrometheusExporter.instance().recordGenericAdminEvent(event);
}

private void logEventDetails(Event event) {
Expand Down
2 changes: 1 addition & 1 deletion src/main/java/it/pleaseopen/keycloak/metrics/MetricsEventListenerFactory.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ public class MetricsEventListenerFactory implements EventListenerProviderFactory

@Override
public EventListenerProvider create(KeycloakSession session) {
return new MetricsEventListener(session.realms());
return new MetricsEventListener();
}

@Override
Expand Down
85 changes: 27 additions & 58 deletions src/main/java/it/pleaseopen/keycloak/metrics/PrometheusExporter.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,6 @@
import org.keycloak.events.EventType;
import org.keycloak.events.admin.AdminEvent;
import org.keycloak.events.admin.OperationType;
import org.keycloak.models.RealmModel;
import org.keycloak.models.RealmProvider;

import java.io.BufferedWriter;
import java.io.IOException;
Expand Down Expand Up @@ -118,31 +116,29 @@ private static io.micrometer.core.instrument.Counter.Builder createCounter(final
* Count generic user event
*
* @param event User event
* @param realmProvider
*/
public void recordGenericEvent(final Event event, RealmProvider realmProvider) {
public void recordGenericEvent(final Event event) {
final String counterName = buildCounterName(event.getType());
if (counters.get(counterName) == null) {
logger.warnf("Counter for event type %s does not exist. Realm: %s", event.getType().name(), nullToEmpty(getRealmName(event.getRealmId(), realmProvider)));
logger.warnf("Counter for event type %s does not exist. Realm: %s", event.getType().name(), nullToEmpty(event.getRealmName()));
return;
}
counters.get(counterName).tags("realm",nullToEmpty(getRealmName(event.getRealmId(), realmProvider))).register(meterRegistry).increment();
counters.get(counterName).tags("realm",nullToEmpty(event.getRealmName())).register(meterRegistry).increment();
//pushAsync();
}

/**
* Count generic admin event
*
* @param event Admin event
* @param realmProvider
*/
public void recordGenericAdminEvent(final AdminEvent event, RealmProvider realmProvider) {
public void recordGenericAdminEvent(final AdminEvent event) {
final String counterName = buildCounterName(event.getOperationType());
if (counters.get(counterName) == null) {
logger.warnf("Counter for admin event operation type %s does not exist. Resource type: %s, realm: %s", event.getOperationType().name(), event.getResourceType().name(), event.getRealmId());
return;
}
counters.get(counterName).tags("realm",nullToEmpty(getRealmName(event.getRealmId(), realmProvider)), "resource", event.getResourceType().name()).register(meterRegistry).increment();
counters.get(counterName).tags("realm",nullToEmpty(event.getRealmName()), "resource", event.getResourceType().name()).register(meterRegistry).increment();

//pushAsync();
}
Expand All @@ -151,122 +147,112 @@ public void recordGenericAdminEvent(final AdminEvent event, RealmProvider realmP
* Increase the number of currently logged in users
*
* @param event Login event
* @param realmProvider
*/
public void recordLogin(final Event event, RealmProvider realmProvider) {
public void recordLogin(final Event event) {
final String provider = getIdentityProvider(event);
meterRegistry.counter(totalLoginsAttempts, "realm", nullToEmpty(getRealmName(event.getRealmId(), realmProvider)), "provider", provider, "client_id", nullToEmpty(event.getClientId())).increment();
meterRegistry.counter(totalLogins, "realm", nullToEmpty(getRealmName(event.getRealmId(), realmProvider)), "provider", provider, "client_id", nullToEmpty(event.getClientId())).increment();
meterRegistry.counter(totalLoginsAttempts, "realm", nullToEmpty(event.getRealmName()), "provider", provider, "client_id", nullToEmpty(event.getClientId())).increment();
meterRegistry.counter(totalLogins, "realm", nullToEmpty(event.getRealmName()), "provider", provider, "client_id", nullToEmpty(event.getClientId())).increment();
//pushAsync();
}

/**
* Increase the number registered users
*
* @param event Register event
* @param realmProvider
*/
public void recordRegistration(final Event event, RealmProvider realmProvider) {
public void recordRegistration(final Event event) {
final String provider = getIdentityProvider(event);
meterRegistry.counter(totalRegistrations, "realm", nullToEmpty(getRealmName(event.getRealmId(), realmProvider)), "provider", provider, "client_id", nullToEmpty(event.getClientId())).increment();
meterRegistry.counter(totalRegistrations, "realm", nullToEmpty(event.getRealmName()), "provider", provider, "client_id", nullToEmpty(event.getClientId())).increment();
//pushAsync();
}

/**
* Increase the number of failed registered users attemps
*
* @param event RegisterError event
* @param realmProvider
*/
public void recordRegistrationError(final Event event, RealmProvider realmProvider) {
public void recordRegistrationError(final Event event) {
final String provider = getIdentityProvider(event);
meterRegistry.counter(totalRegistrationsErrors, "realm", nullToEmpty(getRealmName(event.getRealmId(), realmProvider)), "provider", provider, "client_id", nullToEmpty(event.getClientId()), "error", nullToEmpty(event.getError())).increment();
meterRegistry.counter(totalRegistrationsErrors, "realm", nullToEmpty(event.getRealmName()), "provider", provider, "client_id", nullToEmpty(event.getClientId()), "error", nullToEmpty(event.getError())).increment();
//pushAsync();
}

/**
* Increase the number of failed login attempts
*
* @param event LoginError event
* @param realmProvider
*/
public void recordLoginError(final Event event, RealmProvider realmProvider) {
public void recordLoginError(final Event event) {
final String provider = getIdentityProvider(event);

meterRegistry.counter(totalLoginsAttempts, "realm", nullToEmpty(getRealmName(event.getRealmId(), realmProvider)), "provider", provider, "client_id", nullToEmpty(event.getClientId())).increment();
meterRegistry.counter(totalFailedLoginAttempts, "realm", nullToEmpty(getRealmName(event.getRealmId(), realmProvider)), "provider", provider, "client_id", nullToEmpty(event.getClientId()), "error", nullToEmpty(event.getError())).increment();
meterRegistry.counter(totalLoginsAttempts, "realm", nullToEmpty(event.getRealmName()), "provider", provider, "client_id", nullToEmpty(event.getClientId())).increment();
meterRegistry.counter(totalFailedLoginAttempts, "realm", nullToEmpty(event.getRealmName()), "provider", provider, "client_id", nullToEmpty(event.getClientId()), "error", nullToEmpty(event.getError())).increment();
//pushAsync();
}

/**
* Increase the number of currently client logged
*
* @param event ClientLogin event
* @param realmProvider
*/
public void recordClientLogin(final Event event, RealmProvider realmProvider) {
public void recordClientLogin(final Event event) {
final String provider = getIdentityProvider(event);
meterRegistry.counter(totalClientLogins, "realm",nullToEmpty(getRealmName(event.getRealmId(), realmProvider)), "provider", provider, "client_id", nullToEmpty(event.getClientId())).increment();
meterRegistry.counter(totalClientLogins, "realm",nullToEmpty(event.getRealmName()), "provider", provider, "client_id", nullToEmpty(event.getClientId())).increment();
//pushAsync();
}

/**
* Increase the number of failed login attempts
*
* @param event ClientLoginError event
* @param realmProvider
*/
public void recordClientLoginError(final Event event, RealmProvider realmProvider) {
public void recordClientLoginError(final Event event) {
final String provider = getIdentityProvider(event);
meterRegistry.counter(totalFailedClientLoginAttempts, "realm",nullToEmpty(getRealmName(event.getRealmId(), realmProvider)), "provider", provider, "client_id", nullToEmpty(event.getClientId()), "error", nullToEmpty(event.getError())).increment();
meterRegistry.counter(totalFailedClientLoginAttempts, "realm",nullToEmpty(event.getRealmName()), "provider", provider, "client_id", nullToEmpty(event.getClientId()), "error", nullToEmpty(event.getError())).increment();
//pushAsync();
}

/**
* Increase the number of refreshes tokens
*
* @param event RefreshToken event
* @param realmProvider
*/
public void recordRefreshToken(final Event event, RealmProvider realmProvider) {
public void recordRefreshToken(final Event event) {
final String provider = getIdentityProvider(event);
meterRegistry.counter(totalRefreshTokens, "realm", nullToEmpty(getRealmName(event.getRealmId(), realmProvider)), "provider", provider, "client_id", nullToEmpty(event.getClientId())).increment();
meterRegistry.counter(totalRefreshTokens, "realm", nullToEmpty(event.getRealmName()), "provider", provider, "client_id", nullToEmpty(event.getClientId())).increment();
//pushAsync();
}

/**
* Increase the number of failed refreshes tokens attempts
*
* @param event RefreshTokenError event
* @param realmProvider
*/
public void recordRefreshTokenError(final Event event, RealmProvider realmProvider) {
public void recordRefreshTokenError(final Event event) {
final String provider = getIdentityProvider(event);
meterRegistry.counter(totalRefreshTokensErrors, "realm", nullToEmpty(getRealmName(event.getRealmId(), realmProvider)), "provider", provider, "client_id", nullToEmpty(event.getClientId()), "error", nullToEmpty(event.getError())).increment();
meterRegistry.counter(totalRefreshTokensErrors, "realm", nullToEmpty(event.getRealmName()), "provider", provider, "client_id", nullToEmpty(event.getClientId()), "error", nullToEmpty(event.getError())).increment();
//pushAsync();
}

/**
* Increase the number of code to tokens
*
* @param event CodeToToken event
* @param realmProvider
*/
public void recordCodeToToken(final Event event, RealmProvider realmProvider) {
public void recordCodeToToken(final Event event) {
final String provider = getIdentityProvider(event);
meterRegistry.counter(totalCodeToTokens, "realm", nullToEmpty(getRealmName(event.getRealmId(), realmProvider)), "provider", provider, "client_id", nullToEmpty(event.getClientId())).increment();
meterRegistry.counter(totalCodeToTokens, "realm", nullToEmpty(event.getRealmName()), "provider", provider, "client_id", nullToEmpty(event.getClientId())).increment();
//pushAsync();
}

/**
* Increase the number of failed code to tokens attempts
*
* @param event CodeToTokenError event
* @param realmProvider
*/
public void recordCodeToTokenError(final Event event, RealmProvider realmProvider) {
public void recordCodeToTokenError(final Event event) {
final String provider = getIdentityProvider(event);
meterRegistry.counter(totalCodeToTokensErrors, "realm", nullToEmpty(getRealmName(event.getRealmId(), realmProvider)), "provider", provider, "client_id", nullToEmpty(event.getClientId()), "error", nullToEmpty(event.getError())).increment();
meterRegistry.counter(totalCodeToTokensErrors, "realm", nullToEmpty(event.getRealmName()), "provider", provider, "client_id", nullToEmpty(event.getClientId()), "error", nullToEmpty(event.getError())).increment();
//pushAsync();
}

Expand All @@ -288,23 +274,6 @@ private String getIdentityProvider(Event event) {
return identityProvider;
}

/**
* Retrieve the real realm name in the event by id from the RealmProvider.
*
* @param realmId Id of Realm
* @param realmProvider RealmProvider instance
* @return Realm name
*/
private String getRealmName(String realmId, RealmProvider realmProvider) {
RealmModel realm = null;
if (realmId != null) {
realm = realmProvider.getRealm(realmId);
}
if (realm != null) {
return realm.getName();
}
return null;
}
/**
* Write the Prometheus formatted values of all counters and
* gauges to the stream
Expand Down
Loading