Add properties for default config of auto-timed controller metrics

When `management.metrics.web.server.autoTimeRequests` is enabled
(default=true), spring-boot collects metrics on controller methods even
when they are not annotated with `@Timed`.
When this happens, created metrics are based on the default configuration
values of `@Timed`.
Currently, there is no way to specify the default configuration to those
auto-timed controller metrics.

This commit introduces two properties:
- `management.metrics.web.server.autoTimeRequestsDefaultPercentiles`
- `management.metrics.web.server.autoTimeRequestsDefaultHistogram`

When values are set to the above properties, they will be applied to
auto-timed controller metrics.

Author: ttddyy

spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/metrics/MetricsProperties.java

@@ -19,6 +19,8 @@
 import java.util.LinkedHashMap;
 import java.util.Map;
 
+import io.micrometer.core.annotation.Timed;
+
 import org.springframework.boot.context.properties.ConfigurationProperties;
 
 /**
@@ -133,6 +135,20 @@ public static class Server {
 			 */
 			private boolean autoTimeRequests = true;
 
+			/**
+			 * Default percentiles when {@link #autoTimeRequests} is {@code true} and
+			 * {@link Timed} is not presented on the corresponding request handler. Any
+			 * {@link Timed} annotation presented will have precedence.
+			 */
+			private double[] autoTimeRequestsDefaultPercentiles;
+
+			/**
+			 * Default histogram when {@link #autoTimeRequests} is {@code true} and
+			 * {@link Timed} is not presented on the corresponding request handler. Any
+			 * {@link Timed} annotation presented will have precedence.
+			 */
+			private boolean autoTimeRequestsDefaultHistogram;
+
 			/**
 			 * Name of the metric for received requests.
 			 */
@@ -153,6 +169,24 @@ public void setAutoTimeRequests(boolean autoTimeRequests) {
 				this.autoTimeRequests = autoTimeRequests;
 			}
 
+			public double[] getAutoTimeRequestsDefaultPercentiles() {
+				return this.autoTimeRequestsDefaultPercentiles;
+			}
+
+			public void setAutoTimeRequestsDefaultPercentiles(
+					double[] autoTimeRequestsDefaultPercentiles) {
+				this.autoTimeRequestsDefaultPercentiles = autoTimeRequestsDefaultPercentiles;
+			}
+
+			public boolean isAutoTimeRequestsDefaultHistogram() {
+				return this.autoTimeRequestsDefaultHistogram;
+			}
+
+			public void setAutoTimeRequestsDefaultHistogram(
+					boolean autoTimeRequestsDefaultHistogram) {
+				this.autoTimeRequestsDefaultHistogram = autoTimeRequestsDefaultHistogram;
+			}
+
 			public String getRequestsMetricName() {
 				return this.requestsMetricName;
 			}

spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/metrics/web/reactive/WebFluxMetricsAutoConfiguration.java

@@ -21,6 +21,7 @@
 
 import org.springframework.boot.actuate.autoconfigure.metrics.MetricsAutoConfiguration;
 import org.springframework.boot.actuate.autoconfigure.metrics.MetricsProperties;
+import org.springframework.boot.actuate.autoconfigure.metrics.MetricsProperties.Web.Server;
 import org.springframework.boot.actuate.autoconfigure.metrics.OnlyOnceLoggingDenyMeterFilter;
 import org.springframework.boot.actuate.autoconfigure.metrics.export.simple.SimpleMetricsExportAutoConfiguration;
 import org.springframework.boot.actuate.metrics.web.reactive.server.DefaultWebFluxTagsProvider;
@@ -65,9 +66,12 @@ public DefaultWebFluxTagsProvider webfluxTagConfigurer() {
 	@Bean
 	public MetricsWebFilter webfluxMetrics(MeterRegistry registry,
 			WebFluxTagsProvider tagConfigurer) {
+		Server serverProperties = this.properties.getWeb().getServer();
 		return new MetricsWebFilter(registry, tagConfigurer,
-				this.properties.getWeb().getServer().getRequestsMetricName(),
-				this.properties.getWeb().getServer().isAutoTimeRequests());
+				serverProperties.getRequestsMetricName(),
+				serverProperties.isAutoTimeRequests(),
+				serverProperties.getAutoTimeRequestsDefaultPercentiles(),
+				serverProperties.isAutoTimeRequestsDefaultHistogram());
 	}
 
 	@Bean

spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/metrics/web/servlet/WebMvcMetricsAutoConfiguration.java

@@ -81,7 +81,9 @@ public FilterRegistrationBean<WebMvcMetricsFilter> webMvcMetricsFilter(
 		Server serverProperties = this.properties.getWeb().getServer();
 		WebMvcMetricsFilter filter = new WebMvcMetricsFilter(registry, tagsProvider,
 				serverProperties.getRequestsMetricName(),
-				serverProperties.isAutoTimeRequests());
+				serverProperties.isAutoTimeRequests(),
+				serverProperties.getAutoTimeRequestsDefaultPercentiles(),
+				serverProperties.isAutoTimeRequestsDefaultHistogram());
 		FilterRegistrationBean<WebMvcMetricsFilter> registration = new FilterRegistrationBean<>(
 				filter);
 		registration.setOrder(Ordered.HIGHEST_PRECEDENCE + 1);

spring-boot-project/spring-boot-actuator-autoconfigure/src/test/java/org/springframework/boot/actuate/autoconfigure/metrics/web/servlet/WebMvcMetricsAutoConfigurationTests.java

@@ -26,6 +26,8 @@
 
 import io.micrometer.core.instrument.MeterRegistry;
 import io.micrometer.core.instrument.Tag;
+import io.micrometer.core.instrument.Timer;
+import io.micrometer.core.instrument.distribution.HistogramSnapshot;
 import org.junit.Rule;
 import org.junit.Test;
 
@@ -137,6 +139,26 @@ public void shouldNotDenyNorLogIfMaxUrisIsNotReached() {
 				});
 	}
 
+	@Test
+	public void autoTimeRequestsDefaultValues() {
+		this.contextRunner.withUserConfiguration(TestController.class)
+				.withConfiguration(AutoConfigurations.of(MetricsAutoConfiguration.class,
+						WebMvcAutoConfiguration.class))
+				.withPropertyValues(
+						"management.metrics.web.server.autoTimeRequestsDefaultPercentiles=0.5,0.7",
+						"management.metrics.web.server.autoTimeRequestsDefaultHistogram=true")
+				.run((context) -> {
+					MeterRegistry registry = getInitializedMeterRegistry(context);
+					Timer timer = registry.get("http.server.requests").timer();
+					HistogramSnapshot snapshot = timer.takeSnapshot();
+					assertThat(snapshot.percentileValues()).hasSize(2);
+					assertThat(snapshot.percentileValues()[0].percentile())
+							.isEqualTo(0.5);
+					assertThat(snapshot.percentileValues()[1].percentile())
+							.isEqualTo(0.7);
+				});
+	}
+
 	@Test
 	@SuppressWarnings("rawtypes")
 	public void longTaskTimingInterceptorIsRegistered() {

spring-boot-project/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/metrics/web/reactive/server/MetricsWebFilter.java

@@ -20,6 +20,7 @@
 
 import io.micrometer.core.instrument.MeterRegistry;
 import io.micrometer.core.instrument.Tag;
+import io.micrometer.core.instrument.Timer;
 import org.reactivestreams.Publisher;
 import reactor.core.publisher.Mono;
 
@@ -48,6 +49,10 @@ public class MetricsWebFilter implements WebFilter {
 
 	private final boolean autoTimeRequests;
 
+	private final double[] autoTimeRequestsDefaultPercentiles;
+
+	private final boolean autoTimeRequestsDefaultHistogram;
+
 	/**
 	 * Create a new {@code MetricsWebFilter}.
 	 * @param registry the registry to which metrics are recorded
@@ -64,10 +69,19 @@ public MetricsWebFilter(MeterRegistry registry, WebFluxTagsProvider tagsProvider
 
 	public MetricsWebFilter(MeterRegistry registry, WebFluxTagsProvider tagsProvider,
 			String metricName, boolean autoTimeRequests) {
+		this(registry, tagsProvider, metricName, autoTimeRequests, null, false);
+	}
+
+	public MetricsWebFilter(MeterRegistry registry, WebFluxTagsProvider tagsProvider,
+			String metricName, boolean autoTimeRequests,
+			double[] autoTimeRequestsDefaultPercentiles,
+			boolean autoTimeRequestsDefaultHistogram) {
 		this.registry = registry;
 		this.tagsProvider = tagsProvider;
 		this.metricName = metricName;
 		this.autoTimeRequests = autoTimeRequests;
+		this.autoTimeRequestsDefaultPercentiles = autoTimeRequestsDefaultPercentiles;
+		this.autoTimeRequestsDefaultHistogram = autoTimeRequestsDefaultHistogram;
 	}
 
 	@Override
@@ -81,29 +95,27 @@ public Mono<Void> filter(ServerWebExchange exchange, WebFilterChain chain) {
 	private Publisher<Void> filter(ServerWebExchange exchange, Mono<Void> call) {
 		long start = System.nanoTime();
 		ServerHttpResponse response = exchange.getResponse();
-		return call.doOnSuccess((done) -> success(exchange, start)).doOnError((cause) -> {
-			if (response.isCommitted()) {
-				error(exchange, start, cause);
-			}
-			else {
-				response.beforeCommit(() -> {
-					error(exchange, start, cause);
-					return Mono.empty();
+		return call.doOnSuccess((done) -> record(exchange, start, null))
+				.doOnError((cause) -> {
+					if (response.isCommitted()) {
+						record(exchange, start, cause);
+					}
+					else {
+						response.beforeCommit(() -> {
+							record(exchange, start, cause);
+							return Mono.empty();
+						});
+					}
 				});
-			}
-		});
-	}
-
-	private void success(ServerWebExchange exchange, long start) {
-		Iterable<Tag> tags = this.tagsProvider.httpRequestTags(exchange, null);
-		this.registry.timer(this.metricName, tags).record(System.nanoTime() - start,
-				TimeUnit.NANOSECONDS);
 	}
 
-	private void error(ServerWebExchange exchange, long start, Throwable cause) {
+	private void record(ServerWebExchange exchange, long start, Throwable cause) {
 		Iterable<Tag> tags = this.tagsProvider.httpRequestTags(exchange, cause);
-		this.registry.timer(this.metricName, tags).record(System.nanoTime() - start,
-				TimeUnit.NANOSECONDS);
+		Timer.builder(this.metricName).tags(tags)
+				.publishPercentiles(this.autoTimeRequestsDefaultPercentiles)
+				.publishPercentileHistogram(this.autoTimeRequestsDefaultHistogram)
+				.register(this.registry)
+				.record(System.nanoTime() - start, TimeUnit.NANOSECONDS);
 	}
 
 }

spring-boot-project/spring-boot-actuator/src/main/java/org/springframework/boot/actuate/metrics/web/servlet/WebMvcMetricsFilter.java

@@ -61,6 +61,10 @@ public class WebMvcMetricsFilter extends OncePerRequestFilter {
 
 	private final boolean autoTimeRequests;
 
+	private final double[] autoTimeRequestsDefaultPercentiles;
+
+	private final boolean autoTimeRequestsDefaultHistogram;
+
 	/**
 	 * Create a new {@link WebMvcMetricsFilter} instance.
 	 * @param context the source application context
@@ -88,10 +92,31 @@ public WebMvcMetricsFilter(ApplicationContext context, MeterRegistry registry,
 	 */
 	public WebMvcMetricsFilter(MeterRegistry registry, WebMvcTagsProvider tagsProvider,
 			String metricName, boolean autoTimeRequests) {
+		this(registry, tagsProvider, metricName, autoTimeRequests, null, false);
+	}
+
+	/**
+	 * Create a new {@link WebMvcMetricsFilter} instance.
+	 * @param registry the meter registry
+	 * @param tagsProvider the tags provider
+	 * @param metricName the metric name
+	 * @param autoTimeRequests if requests should be automatically timed
+	 * @param autoTimeRequestsDefaultPercentiles default percentiles if requests are auto
+	 * timed
+	 * @param autoTimeRequestsDefaultHistogram default histogram flag if requests are auto
+	 * timed
+	 * @since 2.1.4
+	 */
+	public WebMvcMetricsFilter(MeterRegistry registry, WebMvcTagsProvider tagsProvider,
+			String metricName, boolean autoTimeRequests,
+			double[] autoTimeRequestsDefaultPercentiles,
+			boolean autoTimeRequestsDefaultHistogram) {
 		this.registry = registry;
 		this.tagsProvider = tagsProvider;
 		this.metricName = metricName;
 		this.autoTimeRequests = autoTimeRequests;
+		this.autoTimeRequestsDefaultPercentiles = autoTimeRequestsDefaultPercentiles;
+		this.autoTimeRequestsDefaultHistogram = autoTimeRequestsDefaultHistogram;
 	}
 
 	@Override
@@ -168,7 +193,12 @@ private void record(TimingContext timingContext, HttpServletResponse response,
 				handlerObject, exception);
 		if (annotations.isEmpty()) {
 			if (this.autoTimeRequests) {
-				stop(timerSample, tags, Timer.builder(this.metricName));
+				stop(timerSample, tags,
+						Timer.builder(this.metricName)
+								.publishPercentiles(
+										this.autoTimeRequestsDefaultPercentiles)
+								.publishPercentileHistogram(
+										this.autoTimeRequestsDefaultHistogram));
 			}
 		}
 		else {

spring-boot-project/spring-boot-actuator/src/test/java/org/springframework/boot/actuate/metrics/web/servlet/WebMvcMetricsFilterAutoTimedTests.java

@@ -19,6 +19,8 @@
 import io.micrometer.core.instrument.Clock;
 import io.micrometer.core.instrument.MeterRegistry;
 import io.micrometer.core.instrument.MockClock;
+import io.micrometer.core.instrument.Timer;
+import io.micrometer.core.instrument.distribution.HistogramSnapshot;
 import io.micrometer.core.instrument.simple.SimpleConfig;
 import io.micrometer.core.instrument.simple.SimpleMeterRegistry;
 import org.junit.Before;
@@ -73,8 +75,13 @@ public void setupMockMvc() {
 	@Test
 	public void metricsCanBeAutoTimed() throws Exception {
 		this.mvc.perform(get("/api/10")).andExpect(status().isOk());
-		assertThat(this.registry.get("http.server.requests").tags("status", "200").timer()
-				.count()).isEqualTo(1L);
+		Timer timer = this.registry.get("http.server.requests").tags("status", "200")
+				.timer();
+		assertThat(timer.count()).isEqualTo(1L);
+		HistogramSnapshot snapshot = timer.takeSnapshot();
+		assertThat(snapshot.percentileValues()).hasSize(2);
+		assertThat(snapshot.percentileValues()[0].percentile()).isEqualTo(0.5);
+		assertThat(snapshot.percentileValues()[1].percentile()).isEqualTo(0.95);
 	}
 
 	@Configuration
@@ -96,7 +103,7 @@ MeterRegistry meterRegistry(Clock clock) {
 		public WebMvcMetricsFilter webMetricsFilter(WebApplicationContext context,
 				MeterRegistry registry) {
 			return new WebMvcMetricsFilter(registry, new DefaultWebMvcTagsProvider(),
-					"http.server.requests", true);
+					"http.server.requests", true, new double[] { 0.5, 0.95 }, true);
 		}
 
 	}