Add properties for default config of auto-timed metrics

When `management.metrics.web.server.auto-time-requests` 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 adds default configurations to auto-time requests on both
client and server sides.

These properties are introduced:
- "management.metrics.web.[server|client].request.auto-time.enabled"
- "management.metrics.web.[server|client].request.auto-time.default-percentiles"
- "management.metrics.web.[server|client].request.auto-time.default-histogram"

Also, "requests-metric-name" property is updated:
old: "management.metrics.web.[server|client].requests-metric-name"
new: "management.metrics.web.[server|client].request.metric-name"

This property is removed:
- `management.metrics.web.server.auto-time-requests`

Author: ttddyy

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

@@ -16,7 +16,9 @@
 
 package org.springframework.boot.actuate.autoconfigure.metrics;
 
+import java.util.ArrayList;
 import java.util.LinkedHashMap;
+import java.util.List;
 import java.util.Map;
 
 import org.springframework.boot.context.properties.ConfigurationProperties;
@@ -26,6 +28,7 @@
  *
  * @author Jon Schneider
  * @author Alexander Abramov
+ * @author Tadaya Tsuyukubo
  * @since 2.0.0
  */
 @ConfigurationProperties("management.metrics")
@@ -93,10 +96,7 @@ public Server getServer() {
 
 		public static class Client {
 
-			/**
-			 * Name of the metric for sent requests.
-			 */
-			private String requestsMetricName = "http.client.requests";
+			private final Request request = new Request("http.client.requests");
 
 			/**
 			 * Maximum number of unique URI tag values allowed. After the max number of
@@ -105,12 +105,26 @@ public static class Client {
 			 */
 			private int maxUriTags = 100;
 
+			/**
+			 * Get name of the metric for received requests.
+			 * @return request metric name
+			 * @deprecated since 2.2.0 in favor of {@link Request#getMetricName()}
+			 */
 			public String getRequestsMetricName() {
-				return this.requestsMetricName;
+				return this.request.getMetricName();
 			}
 
+			/**
+			 * Set name of the metric for received requests.
+			 * @param requestsMetricName request metric name
+			 * @deprecated since 2.2.0 in favor of {@link Request#setMetricName(String)}
+			 */
 			public void setRequestsMetricName(String requestsMetricName) {
-				this.requestsMetricName = requestsMetricName;
+				this.request.setMetricName(requestsMetricName);
+			}
+
+			public Request getRequest() {
+				return this.request;
 			}
 
 			public int getMaxUriTags() {
@@ -125,18 +139,7 @@ public void setMaxUriTags(int maxUriTags) {
 
 		public static class Server {
 
-			/**
-			 * Whether requests handled by Spring MVC, WebFlux or Jersey should be
-			 * automatically timed. If the number of time series emitted grows too large
-			 * on account of request mapping timings, disable this and use 'Timed' on a
-			 * per request mapping basis as needed.
-			 */
-			private boolean autoTimeRequests = true;
-
-			/**
-			 * Name of the metric for received requests.
-			 */
-			private String requestsMetricName = "http.server.requests";
+			private final Request request = new Request("http.server.requests");
 
 			/**
 			 * Maximum number of unique URI tag values allowed. After the max number of
@@ -145,20 +148,26 @@ public static class Server {
 			 */
 			private int maxUriTags = 100;
 
-			public boolean isAutoTimeRequests() {
-				return this.autoTimeRequests;
-			}
-
-			public void setAutoTimeRequests(boolean autoTimeRequests) {
-				this.autoTimeRequests = autoTimeRequests;
-			}
-
+			/**
+			 * Get name of the metric for received requests.
+			 * @return request metric name
+			 * @deprecated since 2.2.0 in favor of {@link Request#getMetricName()}
+			 */
 			public String getRequestsMetricName() {
-				return this.requestsMetricName;
+				return this.request.getMetricName();
 			}
 
+			/**
+			 * Set name of the metric for received requests.
+			 * @param requestsMetricName request metric name
+			 * @deprecated since 2.2.0 in favor of {@link Request#setMetricName(String)}
+			 */
 			public void setRequestsMetricName(String requestsMetricName) {
-				this.requestsMetricName = requestsMetricName;
+				this.request.setMetricName(requestsMetricName);
+			}
+
+			public Request getRequest() {
+				return this.request;
 			}
 
 			public int getMaxUriTags() {
@@ -171,6 +180,86 @@ public void setMaxUriTags(int maxUriTags) {
 
 		}
 
+		public static class Request {
+
+			public Request(String metricName) {
+				this.metricName = metricName;
+			}
+
+			/**
+			 * Automatically time requests.
+			 */
+			private final AutoTime autoTime = new AutoTime();
+
+			/**
+			 * Name of the metric for received requests.
+			 */
+			private String metricName;
+
+			public AutoTime getAutoTime() {
+				return this.autoTime;
+			}
+
+			public String getMetricName() {
+				return this.metricName;
+			}
+
+			public void setMetricName(String metricName) {
+				this.metricName = metricName;
+			}
+
+			public static class AutoTime {
+
+				/**
+				 * Whether requests handled by Spring MVC, WebFlux or Jersey should be
+				 * automatically timed. If the number of time series emitted grows too
+				 * large on account of request mapping timings, disable this and use
+				 * 'Timed' on a per request mapping basis as needed.
+				 */
+				private boolean enabled = true;
+
+				/**
+				 * Default percentiles when @Timed annotation is not presented on the
+				 * corresponding request handler. Any @Timed annotation presented will
+				 * have precedence.
+				 */
+				private List<Double> defaultPercentiles = new ArrayList<>();
+
+				/**
+				 * Default histogram when @Timed annotation is not presented on the
+				 * corresponding request handler. Any @Timed annotation presented will
+				 * have precedence.
+				 */
+				private boolean defaultHistogram;
+
+				public boolean isEnabled() {
+					return this.enabled;
+				}
+
+				public void setEnabled(boolean enabled) {
+					this.enabled = enabled;
+				}
+
+				public List<Double> getDefaultPercentiles() {
+					return this.defaultPercentiles;
+				}
+
+				public void setDefaultPercentiles(List<Double> defaultPercentiles) {
+					this.defaultPercentiles = defaultPercentiles;
+				}
+
+				public boolean isDefaultHistogram() {
+					return this.defaultHistogram;
+				}
+
+				public void setDefaultHistogram(boolean defaultHistogram) {
+					this.defaultHistogram = defaultHistogram;
+				}
+
+			}
+
+		}
+
 	}
 
 	public static class Distribution {

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

@@ -79,14 +79,16 @@ public ResourceConfigCustomizer jerseyServerMetricsResourceConfigCustomizer(
 			MeterRegistry meterRegistry, JerseyTagsProvider tagsProvider) {
 		Server server = this.properties.getWeb().getServer();
 		return (config) -> config.register(new MetricsApplicationEventListener(
-				meterRegistry, tagsProvider, server.getRequestsMetricName(),
-				server.isAutoTimeRequests(), new AnnotationUtilsAnnotationFinder()));
+				meterRegistry, tagsProvider, server.getRequest().getMetricName(),
+				server.getRequest().getAutoTime().isEnabled(),
+				new AnnotationUtilsAnnotationFinder()));
 	}
 
 	@Bean
 	@Order(0)
 	public MeterFilter jerseyMetricsUriTagFilter() {
-		String metricName = this.properties.getWeb().getServer().getRequestsMetricName();
+		String metricName = this.properties.getWeb().getServer().getRequest()
+				.getMetricName();
 		MeterFilter filter = new OnlyOnceLoggingDenyMeterFilter(() -> String
 				.format("Reached the maximum number of URI tags for '%s'.", metricName));
 		return MeterFilter.maximumAllowableTags(metricName, "uri",

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

@@ -53,7 +53,7 @@ public class HttpClientMetricsAutoConfiguration {
 	@Bean
 	@Order(0)
 	public MeterFilter metricsHttpClientUriTagFilter(MetricsProperties properties) {
-		String metricName = properties.getWeb().getClient().getRequestsMetricName();
+		String metricName = properties.getWeb().getClient().getRequest().getMetricName();
 		MeterFilter denyFilter = new OnlyOnceLoggingDenyMeterFilter(() -> String
 				.format("Reached the maximum number of URI tags for '%s'. Are you using "
 						+ "'uriVariables'?", metricName));

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

@@ -19,6 +19,8 @@
 import io.micrometer.core.instrument.MeterRegistry;
 
 import org.springframework.boot.actuate.autoconfigure.metrics.MetricsProperties;
+import org.springframework.boot.actuate.autoconfigure.metrics.MetricsProperties.Web.Client;
+import org.springframework.boot.actuate.autoconfigure.metrics.MetricsProperties.Web.Request.AutoTime;
 import org.springframework.boot.actuate.metrics.web.client.DefaultRestTemplateExchangeTagsProvider;
 import org.springframework.boot.actuate.metrics.web.client.MetricsRestTemplateCustomizer;
 import org.springframework.boot.actuate.metrics.web.client.RestTemplateExchangeTagsProvider;
@@ -53,9 +55,13 @@ public MetricsRestTemplateCustomizer metricsRestTemplateCustomizer(
 			MeterRegistry meterRegistry,
 			RestTemplateExchangeTagsProvider restTemplateExchangeTagsProvider,
 			MetricsProperties properties) {
+
+		Client client = properties.getWeb().getClient();
+		AutoTime autoTime = client.getRequest().getAutoTime();
 		return new MetricsRestTemplateCustomizer(meterRegistry,
-				restTemplateExchangeTagsProvider,
-				properties.getWeb().getClient().getRequestsMetricName());
+				restTemplateExchangeTagsProvider, client.getRequest().getMetricName(),
+				autoTime.isEnabled(), autoTime.getDefaultPercentiles(),
+				autoTime.isDefaultHistogram());
 	}
 
 }

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

@@ -49,7 +49,7 @@ public MetricsWebClientCustomizer metricsWebClientCustomizer(
 			MeterRegistry meterRegistry, WebClientExchangeTagsProvider tagsProvider,
 			MetricsProperties properties) {
 		return new MetricsWebClientCustomizer(meterRegistry, tagsProvider,
-				properties.getWeb().getClient().getRequestsMetricName());
+				properties.getWeb().getClient().getRequest().getMetricName());
 	}
 
 }

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

@@ -21,6 +21,8 @@
 
 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.Request.AutoTime;
+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,15 +67,18 @@ public DefaultWebFluxTagsProvider webfluxTagConfigurer() {
 	@Bean
 	public MetricsWebFilter webfluxMetrics(MeterRegistry registry,
 			WebFluxTagsProvider tagConfigurer) {
+		Server serverProperties = this.properties.getWeb().getServer();
+		AutoTime autotime = serverProperties.getRequest().getAutoTime();
 		return new MetricsWebFilter(registry, tagConfigurer,
-				this.properties.getWeb().getServer().getRequestsMetricName(),
-				this.properties.getWeb().getServer().isAutoTimeRequests());
+				serverProperties.getRequest().getMetricName(), autotime.isEnabled(),
+				autotime.getDefaultPercentiles(), autotime.isDefaultHistogram());
 	}
 
 	@Bean
 	@Order(0)
 	public MeterFilter metricsHttpServerUriTagFilter() {
-		String metricName = this.properties.getWeb().getServer().getRequestsMetricName();
+		String metricName = this.properties.getWeb().getServer().getRequest()
+				.getMetricName();
 		MeterFilter filter = new OnlyOnceLoggingDenyMeterFilter(() -> String
 				.format("Reached the maximum number of URI tags for '%s'.", metricName));
 		return MeterFilter.maximumAllowableTags(metricName, "uri",

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

@@ -23,6 +23,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.Request.AutoTime;
 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;
@@ -79,9 +80,10 @@ public DefaultWebMvcTagsProvider webMvcTagsProvider() {
 	public FilterRegistrationBean<WebMvcMetricsFilter> webMvcMetricsFilter(
 			MeterRegistry registry, WebMvcTagsProvider tagsProvider) {
 		Server serverProperties = this.properties.getWeb().getServer();
+		AutoTime autotime = serverProperties.getRequest().getAutoTime();
 		WebMvcMetricsFilter filter = new WebMvcMetricsFilter(registry, tagsProvider,
-				serverProperties.getRequestsMetricName(),
-				serverProperties.isAutoTimeRequests());
+				serverProperties.getRequest().getMetricName(), autotime.isEnabled(),
+				autotime.getDefaultPercentiles(), autotime.isDefaultHistogram());
 		FilterRegistrationBean<WebMvcMetricsFilter> registration = new FilterRegistrationBean<>(
 				filter);
 		registration.setOrder(Ordered.HIGHEST_PRECEDENCE + 1);
@@ -92,7 +94,8 @@ public FilterRegistrationBean<WebMvcMetricsFilter> webMvcMetricsFilter(
 	@Bean
 	@Order(0)
 	public MeterFilter metricsHttpServerUriTagFilter() {
-		String metricName = this.properties.getWeb().getServer().getRequestsMetricName();
+		String metricName = this.properties.getWeb().getServer().getRequest()
+				.getMetricName();
 		MeterFilter filter = new OnlyOnceLoggingDenyMeterFilter(() -> String
 				.format("Reached the maximum number of URI tags for '%s'.", metricName));
 		return MeterFilter.maximumAllowableTags(metricName, "uri",

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

@@ -102,7 +102,7 @@ public void metricsAreNotRecordedIfAutoTimeRequestsIsDisabled() {
 				.withConfiguration(AutoConfigurations.of(WebFluxAutoConfiguration.class))
 				.withUserConfiguration(TestController.class)
 				.withPropertyValues(
-						"management.metrics.web.server.auto-time-requests=false")
+						"management.metrics.web.server.request.auto-time.enabled=false")
 				.run((context) -> {
 					MeterRegistry registry = getInitializedMeterRegistry(context);
 					assertThat(registry.find("http.server.requests").meter()).isNull();

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,27 @@ public void shouldNotDenyNorLogIfMaxUrisIsNotReached() {
 				});
 	}
 
+	@Test
+	public void autoTimeRequestsDefaultValues() {
+		this.contextRunner.withUserConfiguration(TestController.class)
+				.withConfiguration(AutoConfigurations.of(MetricsAutoConfiguration.class,
+						WebMvcAutoConfiguration.class))
+				.withPropertyValues(
+						"management.metrics.web.server.request.auto-time.enabled=true",
+						"management.metrics.web.server.request.auto-time.default-percentiles=0.5,0.7",
+						"management.metrics.web.server.request.auto-time.default-histogram=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() {