Skip to content

Commit 0a95159

Browse files
authored
Ignore Health and Metrics artifacts (keycloak#22438)
Closes keycloak#22437 Signed-off-by: Martin Bartoš <mabartos@redhat.com>
1 parent f78c54f commit 0a95159

3 files changed

Lines changed: 69 additions & 2 deletions

File tree

‎quarkus/runtime/src/main/java/org/keycloak/quarkus/runtime/configuration/IgnoredArtifacts.java‎

Lines changed: 36 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,10 +21,15 @@
2121

2222
import java.util.Collection;
2323
import java.util.HashSet;
24+
25+
import org.keycloak.config.HealthOptions;
26+
import org.keycloak.config.MetricsOptions;
27+
2428
import java.util.Set;
2529
import java.util.stream.Collectors;
2630
import java.util.stream.Stream;
2731

32+
import static java.util.Collections.emptySet;
2833
import static org.keycloak.quarkus.runtime.Environment.getCurrentOrCreateFeatureProfile;
2934

3035
/**
@@ -35,7 +40,9 @@ public class IgnoredArtifacts {
3540
public static Set<String> getDefaultIgnoredArtifacts() {
3641
return Stream.of(
3742
fips(),
38-
jdbcDrivers()
43+
jdbcDrivers(),
44+
health(),
45+
metrics()
3946
)
4047
.flatMap(Collection::stream)
4148
.collect(Collectors.toUnmodifiableSet());
@@ -130,4 +137,32 @@ private static Set<String> jdbcDrivers() {
130137
allJdbcDrivers.removeAll(jdbcArtifacts);
131138
return allJdbcDrivers;
132139
}
140+
141+
// Health
142+
public static final Set<String> HEALTH = Set.of(
143+
"io.quarkus:quarkus-smallrye-health",
144+
"io.quarkus:quarkus-smallrye-health-deployment"
145+
);
146+
147+
private static Set<String> health() {
148+
boolean isHealthEnabled = Configuration.getOptionalBooleanValue(
149+
MicroProfileConfigProvider.NS_KEYCLOAK_PREFIX + HealthOptions.HEALTH_ENABLED.getKey()).orElse(false);
150+
151+
return !isHealthEnabled ? HEALTH : emptySet();
152+
}
153+
154+
// Metrics
155+
public static Set<String> METRICS = Set.of(
156+
"io.quarkus:quarkus-micrometer",
157+
"io.quarkus:quarkus-micrometer-deployment",
158+
"io.quarkus:quarkus-micrometer-registry-prometheus",
159+
"io.quarkus:quarkus-micrometer-registry-prometheus-deployment"
160+
);
161+
162+
private static Set<String> metrics() {
163+
boolean isMetricsEnabled = Configuration.getOptionalBooleanValue(
164+
MicroProfileConfigProvider.NS_KEYCLOAK_PREFIX + MetricsOptions.METRICS_ENABLED.getKey()).orElse(false);
165+
166+
return !isMetricsEnabled ? METRICS : emptySet();
167+
}
133168
}

‎quarkus/runtime/src/main/resources/application.properties‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ quarkus.datasource.health.enabled=false
1717
quarkus.micrometer.binder.http-server.enabled=false
1818

1919
# Enables metrics from other extensions if metrics is enabled
20-
quarkus.datasource.metrics.enabled=${quarkus.micrometer.enabled}
20+
quarkus.datasource.metrics.enabled=${quarkus.micrometer.enabled:false}
2121

2222
# Default transaction timeout
2323
quarkus.transaction-manager.default-transaction-timeout=300

‎quarkus/runtime/src/test/java/org/keycloak/quarkus/runtime/configuration/test/IgnoredArtifactsTest.java‎

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,8 @@
2222
import org.keycloak.common.Profile;
2323
import org.keycloak.common.profile.PropertiesProfileConfigResolver;
2424
import org.keycloak.config.DatabaseOptions;
25+
import org.keycloak.config.HealthOptions;
26+
import org.keycloak.config.MetricsOptions;
2527
import org.keycloak.quarkus.runtime.configuration.IgnoredArtifacts;
2628
import org.keycloak.quarkus.runtime.configuration.MicroProfileConfigProvider;
2729

@@ -109,4 +111,34 @@ private void assertJdbc(String vendor, Set<String> notIgnored) {
109111
System.setProperty(MicroProfileConfigProvider.NS_KEYCLOAK_PREFIX + DatabaseOptions.DB.getKey(), "");
110112
}
111113
}
114+
115+
@Test
116+
public void health() {
117+
var ignoredArtifacts = IgnoredArtifacts.getDefaultIgnoredArtifacts();
118+
// Health disabled by default
119+
assertThat(ignoredArtifacts.containsAll(IgnoredArtifacts.HEALTH), is(true));
120+
121+
System.setProperty(MicroProfileConfigProvider.NS_KEYCLOAK_PREFIX + HealthOptions.HEALTH_ENABLED.getKey(), "true");
122+
try {
123+
final var artifacts = IgnoredArtifacts.getDefaultIgnoredArtifacts();
124+
assertThat(artifacts.containsAll(IgnoredArtifacts.HEALTH), is(false));
125+
} finally {
126+
System.setProperty(MicroProfileConfigProvider.NS_KEYCLOAK_PREFIX + HealthOptions.HEALTH_ENABLED.getKey(), "");
127+
}
128+
}
129+
130+
@Test
131+
public void metrics() {
132+
var ignoredArtifacts = IgnoredArtifacts.getDefaultIgnoredArtifacts();
133+
// Metrics disabled by default
134+
assertThat(ignoredArtifacts.containsAll(IgnoredArtifacts.METRICS), is(true));
135+
136+
System.setProperty(MicroProfileConfigProvider.NS_KEYCLOAK_PREFIX + MetricsOptions.METRICS_ENABLED.getKey(), "true");
137+
try {
138+
final var artifacts = IgnoredArtifacts.getDefaultIgnoredArtifacts();
139+
assertThat(artifacts.containsAll(IgnoredArtifacts.METRICS), is(false));
140+
} finally {
141+
System.setProperty(MicroProfileConfigProvider.NS_KEYCLOAK_PREFIX + HealthOptions.HEALTH_ENABLED.getKey(), "");
142+
}
143+
}
112144
}

0 commit comments

Comments
 (0)