Disable GraphQL metrics by default

(cherry picked from commit 2df73cf)
gsmet · Jun 3, 2021 · 7f90bfe · 7f90bfe
1 parent 3a88e59
commit 7f90bfe
Show file tree

Hide file tree

Showing 3 changed files with 14 additions and 11 deletions.
diff --git a/...eployment/src/main/java/io/quarkus/smallrye/graphql/deployment/SmallRyeGraphQLConfig.java b/...eployment/src/main/java/io/quarkus/smallrye/graphql/deployment/SmallRyeGraphQLConfig.java
@@ -19,7 +19,7 @@ public class SmallRyeGraphQLConfig {
     String rootPath;
 
     /**
-     * Enable metrics. By default this will be enabled if the metrics extension is added.
+     * Enable metrics. By default this is false. If set to true, a metrics extension is required.
      */
     @ConfigItem(name = "metrics.enabled")
     Optional<Boolean> metricsEnabled;

diff --git a/...oyment/src/main/java/io/quarkus/smallrye/graphql/deployment/SmallRyeGraphQLProcessor.java b/...oyment/src/main/java/io/quarkus/smallrye/graphql/deployment/SmallRyeGraphQLProcessor.java
@@ -404,7 +404,8 @@ void activateMetrics(Capabilities capabilities,
                 metricsCapability.isPresent(),
                 "quarkus-smallrye-metrics",
                 "metrics",
-                "quarkus.smallrye-graphql.metrics.enabled");
+                "quarkus.smallrye-graphql.metrics.enabled",
+                false);
         if (activate) {
             if (metricsCapability.isPresent() && metricsCapability.get().metricsSupported(MetricsFactory.MP_METRICS)) {
                 unremovableBeans.produce(UnremovableBeanBuildItem.beanClassNames("io.smallrye.metrics.MetricRegistries"));
@@ -424,7 +425,8 @@ void activateTracing(Capabilities capabilities,
                 graphQLConfig.tracingEnabled,
                 "quarkus-smallrye-opentracing",
                 Capability.OPENTRACING,
-                "quarkus.smallrye-graphql.tracing.enabled");
+                "quarkus.smallrye-graphql.tracing.enabled",
+                true);
         if (activate) {
             systemProperties.produce(new SystemPropertyBuildItem(ConfigKey.ENABLE_TRACING, TRUE));
         } else {
@@ -441,7 +443,8 @@ void activateValidation(Capabilities capabilities,
                 graphQLConfig.validationEnabled,
                 "quarkus-hibernate-validator",
                 Capability.HIBERNATE_VALIDATOR,
-                "quarkus.smallrye-graphql.validation.enabled");
+                "quarkus.smallrye-graphql.validation.enabled",
+                true);
         if (activate) {
             systemProperties.produce(new SystemPropertyBuildItem(ConfigKey.ENABLE_VALIDATION, TRUE));
         } else {
@@ -462,18 +465,20 @@ private boolean shouldActivateService(Capabilities capabilities,
             Optional<Boolean> serviceEnabled,
             String linkedExtensionName,
             String linkedCapability,
-            String configKey) {
+            String configKey,
+            boolean activateByDefaultIfCapabilityIsPresent) {
 
         return shouldActivateService(capabilities, serviceEnabled, capabilities.isPresent(linkedCapability),
-                linkedExtensionName, linkedCapability, configKey);
+                linkedExtensionName, linkedCapability, configKey, activateByDefaultIfCapabilityIsPresent);
     }
 
     private boolean shouldActivateService(Capabilities capabilities,
             Optional<Boolean> serviceEnabled,
             boolean linkedCapabilityIsPresent,
             String linkedExtensionName,
             String linkedCapabilityName,
-            String configKey) {
+            String configKey,
+            boolean activateByDefaultIfCapabilityIsPresent) {
 
         if (serviceEnabled.isPresent()) {
             // The user explicitly asked from something
@@ -485,7 +490,7 @@ private boolean shouldActivateService(Capabilities capabilities,
             return (isEnabled && linkedCapabilityIsPresent);
         } else {
             // Auto dis/enable
-            return linkedCapabilityIsPresent;
+            return linkedCapabilityIsPresent && activateByDefaultIfCapabilityIsPresent;
         }
     }
 

diff --git a/.../deployment/src/test/java/io/quarkus/smallrye/graphql/deployment/MetricsDisabledTest.java b/.../deployment/src/test/java/io/quarkus/smallrye/graphql/deployment/MetricsDisabledTest.java
@@ -10,15 +10,14 @@
 import org.eclipse.microprofile.metrics.annotation.RegistryType;
 import org.jboss.shrinkwrap.api.ShrinkWrap;
 import org.jboss.shrinkwrap.api.asset.EmptyAsset;
-import org.jboss.shrinkwrap.api.asset.StringAsset;
 import org.jboss.shrinkwrap.api.spec.JavaArchive;
 import org.junit.jupiter.api.Test;
 import org.junit.jupiter.api.extension.RegisterExtension;
 
 import io.quarkus.test.QuarkusUnitTest;
 
 /**
- * Verify that quarkus.smallrye-graphql.metrics.enabled=false turn off GraphQL metrics even
+ * Verify that GraphQL metrics are disabled by default even
  * if the SmallRye Metrics extension is present.
  */
 public class MetricsDisabledTest {
@@ -27,7 +26,6 @@ public class MetricsDisabledTest {
     static QuarkusUnitTest test = new QuarkusUnitTest()
             .setArchiveProducer(() -> ShrinkWrap.create(JavaArchive.class)
                     .addClasses(TestResource.class, TestPojo.class, TestRandom.class, TestGenericsPojo.class)
-                    .addAsResource(new StringAsset("quarkus.smallrye-graphql.metrics.enabled=false"), "application.properties")
                     .addAsManifestResource(EmptyAsset.INSTANCE, "beans.xml"));
 
     @Inject