Disable actuator metrics by default (#927)

* disable actuator metrics by default

* replace application.yml metrics filtering by meterRegistryCustomizer

  This makes it easier to enable/disable the metrics just by exposing 'metrics', instead of changing two separate configuration settings.
  Also clarifies the intention of filtering and is easier to override using env variable MANAGEMENT_ENDPOINTS_WEB_EXPOSURE_INCLUDE.

* rename ActuatorConfig to ActuatorMetricsConfig

* enable/expose http.server.requests metrics in MetricsTest

Author: dennisvang

…fairdatapoint/config/ActuatorConfig.java …apoint/config/ActuatorMetricsConfig.javasrc/main/java/org/fairdatateam/fairdatapoint/config/ActuatorConfig.java renamed to src/main/java/org/fairdatateam/fairdatapoint/config/ActuatorMetricsConfig.java src/main/java/org/fairdatateam/fairdatapoint/config/ActuatorConfig.java renamed to src/main/java/org/fairdatateam/fairdatapoint/config/ActuatorMetricsConfig.java

@@ -23,19 +23,50 @@
 package org.fairdatateam.fairdatapoint.config;
 
 import io.micrometer.common.KeyValue;
+import io.micrometer.core.instrument.MeterRegistry;
+import io.micrometer.core.instrument.config.MeterFilter;
+import lombok.extern.slf4j.Slf4j;
+import org.springframework.boot.actuate.autoconfigure.metrics.MeterRegistryCustomizer;
+import org.springframework.boot.autoconfigure.condition.ConditionalOnExpression;
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
 import org.springframework.http.server.observation.DefaultServerRequestObservationConvention;
 import org.springframework.http.server.observation.ServerRequestObservationContext;
 
+@Slf4j
 @Configuration
-public class ActuatorConfig {
+@ConditionalOnExpression("'${management.endpoints.web.exposure.include}'.contains('metrics')")
+public class ActuatorMetricsConfig {
+
+    private final String meterName = "http.server.requests";
+
+    /**
+     * Disables all actuator meters except for http.server.requests.
+     * See <a href="https://docs.micrometer.io/micrometer/reference/concepts/meter-filters.html">meter filters</a>.
+     * This is the equivalent of the following <code>application.yml</code> settings:
+     * <pre>
+     *     management:
+     *       metrics:
+     *         enable:
+     *           all: false
+     *           http.server.requests: true
+     *           http.server.requests.active: false
+     * </pre>
+     */
+    @Bean
+    public MeterRegistryCustomizer<MeterRegistry> meterRegistryCustomizer() {
+        log.info("Denying all meters except {}", meterName);
+        return registry -> {
+            registry.config().meterFilter(MeterFilter.denyUnless(id -> id.getName().equals(meterName)));
+        };
+    }
 
     /**
-     * Replaces the default `uri` path-pattern values with full paths in actuator metrics http.server.requests
+     * Replaces the default uri path-pattern values with full paths in actuator metrics http.server.requests
      */
     @Bean
     DefaultServerRequestObservationConvention customServerRequestObservationConvention() {
+        log.info("Using custom http.url metric for {}.", meterName);
         return new DefaultServerRequestObservationConvention() {
             /**
              * Replace the default URI path pattern (e.g. `/catalog/{id}`) with the full URI path (e.g. `/catalog/123`).

src/main/resources/application.yml

@@ -32,12 +32,10 @@ management:
   endpoints:
     web:
       exposure:
-        include: health, info, metrics
-  metrics:
-    enable:
-      all: false
-      http.server.requests: true
-      http.server.requests.active: false
+        # To expose custom http.server.requests http.url metric, include "metrics".
+        # This can also be done using env variable MANAGEMENT_ENDPOINTS_WEB_EXPOSURE_INCLUDE.
+        # Note the ActuatorMetricsConfig ensures that only the http.server.requests meter is enabled.
+        include: health, info
 
 security:
   jwt:

src/test/java/org/fairdatateam/fairdatapoint/acceptance/actuator/MetricsTest.java

@@ -45,7 +45,7 @@
 
 @ActiveProfiles(Profiles.TESTING)
 @AutoConfigureMockMvc
-@SpringBootTest
+@SpringBootTest(properties = {"management.endpoints.web.exposure.include=health,info,metrics"})
 @WithMockUser
 class MetricsTest {