Properties to set default configuration for auto-timed controller metrics #15988

ttddyy · 2019-02-19T05:31:15Z

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 PR 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 that do not have explicit @Timed annotation.

wilkinsona

Thanks very much for the PR. I left a few comments. Could you please take a look when you have a moment and make the necessary changes if you agree?

wilkinsona · 2019-02-26T13:15:53Z

.../src/main/java/org/springframework/boot/actuate/autoconfigure/metrics/MetricsProperties.java

+			 * {@link Timed} is not presented on the corresponding request handler. Any
+			 * {@link Timed} annotation presented will have precedence.
+			 */
+			private double[] autoTimeRequestsDefaultPercentiles;


The field javadoc is used to document the configuration property in the reference documentation appendix and in the metadata that's used by IDEs. As such, it can't use javadoc tags and must be written in plain text. Can you please rework the description to match the style of the other fields in the class?

wilkinsona · 2019-02-26T13:16:20Z

.../src/main/java/org/springframework/boot/actuate/autoconfigure/metrics/MetricsProperties.java

+			 * {@link Timed} is not presented on the corresponding request handler. Any
+			 * {@link Timed} annotation presented will have precedence.
+			 */
+			private boolean autoTimeRequestsDefaultHistogram;


The field javadoc is used to document the configuration property in the reference documentation appendix and in the metadata that's used by IDEs. As such, it can't use javadoc tags and must be written in plain text. Can you please rework the description to match the style of the other fields in the class?

wilkinsona · 2019-02-26T13:17:47Z

.../src/main/java/org/springframework/boot/actuate/metrics/web/servlet/WebMvcMetricsFilter.java

@@ -88,10 +92,31 @@ public WebMvcMetricsFilter(ApplicationContext context, MeterRegistry registry,
 	 */
 	public WebMvcMetricsFilter(MeterRegistry registry, WebMvcTagsProvider tagsProvider,


I think we should deprecate this constructor in favour of the new one added below.

wilkinsona · 2019-02-26T13:18:20Z

...main/java/org/springframework/boot/actuate/metrics/web/reactive/server/MetricsWebFilter.java

@@ -64,10 +69,19 @@ public MetricsWebFilter(MeterRegistry registry, WebFluxTagsProvider tagsProvider

 	public MetricsWebFilter(MeterRegistry registry, WebFluxTagsProvider tagsProvider,


I think we should deprecate this constructor in favour of the new one added below.

ttddyy · 2019-02-27T01:44:49Z

Hi @wilkinsona
Updated the PR.
I was not sure for what version to put in deprecation javadoc, so I put 2.1.4.

Thanks,

snicoll

I am not sure about those new properties and how they should be structure in configuration. Flagging for team attention to see what the rest of the team thinks.

snicoll · 2019-02-28T15:55:11Z

.../src/main/java/org/springframework/boot/actuate/autoconfigure/metrics/MetricsProperties.java

+			 * not presented on the corresponding request handler. Any @Timed annotation
+			 * presented will have precedence.
+			 */
+			private double[] autoTimeRequestsDefaultPercentiles;


I am not sure about the double[] array, I'd rather use a List for this.

Also we now have three properties around the concept of autoTimeRequests and some keys are now rather long. Shouldn't we take the opportunity to group those in a group?

snicoll · 2019-02-28T15:55:46Z

...main/java/org/springframework/boot/actuate/metrics/web/reactive/server/MetricsWebFilter.java

+	 * @param tagsProvider provider for metrics tags
+	 * @param metricName name of the metric to record
+	 * @param autoTimeRequests if requests should be automatically timed
+	 * @deprecated since 2.1.4 in favor of


This PR is intended to be merged on master only so that should be deprecated as of 2.2.0

snicoll · 2019-02-28T15:58:14Z

.../src/main/java/org/springframework/boot/actuate/autoconfigure/metrics/MetricsProperties.java

@@ -133,6 +133,20 @@ public void setMaxUriTags(int maxUriTags) {
 			 */
 			private boolean autoTimeRequests = true;

+			/**
+			 * Default percentiles when "autoTimeRequests=true" and @Timed annotation is


I don't like the idea of referring one property from another property. The canonical format is not camelCase anyway.

ttddyy · 2019-03-01T00:54:04Z

Added a commit that moves auto-time-requests related properties to an independent AutoTimeRequests properties class.

wilkinsona · 2019-03-20T16:26:50Z

We discussed this a bit and wondered if properties like management.metrics.web.server.request.autotime.default-histogram would be preferable. We'd have similar properties on the client-side beneath management.metrics.web.client.request. We'd need to deprecate some existing properties such as management.metrics.web.server.requests-metric-name and move it to something like management.metrics.web.server.request.metric-name

ttddyy · 2019-03-25T04:44:31Z

@wilkinsona

Updated the review for server side auto-time metrics.

Updated auto-time requests related config to:

management.metrics.web.server.request.auto-time.enabled
management.metrics.web.server.request.auto-time.default-percentiles
management.metrics.web.server.request.auto-time.default-histogram

Updated requests-metric-name:
management.metrics.web.server.requests-metric-name
=> management.metrics.web.server.request.metric-name

Not sure for how to deprecate the entry on properties class.
For now, I just put @deprecated for management.metrics.web.server.requests-metric-name.
If it is ok to just remove them, let me know.

I'll find some time for doing client-side.

ttddyy · 2019-03-27T01:02:31Z

ok, updated the client side as well.

Following properties are added:

management.metrics.web.client.request.auto-time.enabled
management.metrics.web.client.request.auto-time.default-percentiles
management.metrics.web.client.request.auto-time.default-histogram

Also, updated "requests-metric-name":
management.metrics.web.client.requests-metric-name
=> management.metrics.web.client.request.metric-name

ttddyy · 2019-04-11T23:10:54Z

@wilkinsona
I have incorporated the comments and force pushed the squashed commit.
Please take a look.

snicoll

We're almost there but there are still a few things to fix IMO. Let me know if you have time to review those, thanks!

snicoll · 2019-04-17T12:27:38Z

.../src/main/java/org/springframework/boot/actuate/autoconfigure/metrics/MetricsProperties.java

-			 * Name of the metric for sent requests.
-			 */
-			private String requestsMetricName = "http.client.requests";
+			private final Request request = new Request("http.client.requests");


Unfortunately that's not very consistent with what we want in the metadata. The default should be in code rather. Let's go with a ClientRequest that hardcodes the value as it used to in the field.

snicoll · 2019-04-17T12:32:28Z

.../src/main/java/org/springframework/boot/actuate/autoconfigure/metrics/MetricsProperties.java

+			 * Get name of the metric for received requests.
+			 * @return request metric name
+			 * @deprecated since 2.2.0 in favor of {@link Request#getMetricName()}
+			 */


This should have a @DeprecatedConfigurationProperty with the replacement key

snicoll · 2019-04-17T12:32:46Z

.../src/main/java/org/springframework/boot/actuate/autoconfigure/metrics/MetricsProperties.java

-			 * Name of the metric for received requests.
-			 */
-			private String requestsMetricName = "http.server.requests";
+			private final Request request = new Request("http.server.requests");


Idem as above with a ServerRequest

snicoll · 2019-04-17T12:33:03Z

.../src/main/java/org/springframework/boot/actuate/autoconfigure/metrics/MetricsProperties.java

+			 * Get name of the metric for received requests.
+			 * @return request metric name
+			 * @deprecated since 2.2.0 in favor of {@link Request#getMetricName()}
+			 */


This should have a @DeprecatedConfigurationProperty with the replacement key

snicoll · 2019-04-17T12:33:53Z

.../src/main/java/org/springframework/boot/actuate/autoconfigure/metrics/MetricsProperties.java

@@ -171,6 +180,86 @@ public void setMaxUriTags(int maxUriTags) {

 		}

+		public static class Request {
+
+			public Request(String metricName) {


With 2.2 this will break as the binding will consider you want to use constructor binding with a single property. Please remove that constructor.

snicoll · 2019-04-17T12:35:24Z

spring-boot-project/spring-boot-docs/src/main/asciidoc/production-ready-features.adoc

@@ -1801,7 +1801,7 @@ application's absolute start time
 [[production-ready-metrics-spring-mvc]]
 ==== Spring MVC Metrics
 Auto-configuration enables the instrumentation of requests handled by Spring MVC. When
-`management.metrics.web.server.auto-time-requests` is `true`, this instrumentation occurs
+`management.metrics.web.server.auto-time-requests.enabled` is `true`, this instrumentation occurs


That doesn't look like the right key. request.auto-time.enabled ?

snicoll · 2019-04-17T12:35:36Z

spring-boot-project/spring-boot-docs/src/main/asciidoc/production-ready-features.adoc

@@ -1896,7 +1896,7 @@ To customize the tags, provide a `@Bean` that implements `WebFluxTagsProvider`.
 [[production-ready-metrics-jersey-server]]
 ==== Jersey Server Metrics
 Auto-configuration enables the instrumentation of requests handled by the Jersey JAX-RS
-implementation. When `management.metrics.web.server.auto-time-requests` is `true`, this
+implementation. When `management.metrics.web.server.auto-time-requests.enabled` is `true`, this


That doesn't look like the right key. request.auto-time.enabled ?

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`

ttddyy · 2019-04-18T00:49:20Z

ok, incorporated the review comments and updated/rebased/squashed the commit.

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 `@Timed` configuration and there is no way to customize the configuration of those auto-timed controller metrics. This commit adds default configurations to auto-timed requests on both client and server sides. See gh-15988

* pr/15988: Polish "Allow configuration of auto-timed metrics" Allow configuration of auto-timed metrics

snicoll · 2019-05-01T06:29:51Z

@ttddyy thank you for your hard work on this one. This is merged on master with a polish commit.

snicoll · 2019-05-14T08:52:10Z

I can't reopen this pull request but the auto-time-requests property has been removed rather than being deprecated and I missed that as part of the polish. I'll try to restore it in a deprecated fashion now.

This commit makes sure the "auto-time-requests" property is still available in a deprecated fashion. See gh-15988

spring-projects-issues added the status: waiting-for-triage An issue we've not yet triaged label Feb 19, 2019

ttddyy force-pushed the configure-default-auto-timed-controller branch from 31834e2 to dac7aa6 Compare February 19, 2019 18:48

wilkinsona added this to the 2.2.x milestone Feb 26, 2019

wilkinsona added type: enhancement A general enhancement and removed status: waiting-for-triage An issue we've not yet triaged labels Feb 26, 2019

wilkinsona requested changes Feb 26, 2019

View reviewed changes

ttddyy force-pushed the configure-default-auto-timed-controller branch from dac7aa6 to 96712be Compare February 27, 2019 01:40

ttddyy force-pushed the configure-default-auto-timed-controller branch 2 times, most recently from e24f26e to 85138da Compare February 28, 2019 00:11

snicoll reviewed Feb 28, 2019

View reviewed changes

snicoll added the for: team-attention An issue we'd like other members of the team to review label Feb 28, 2019

ttddyy force-pushed the configure-default-auto-timed-controller branch from 85138da to 367e9e7 Compare March 1, 2019 00:50

ttddyy force-pushed the configure-default-auto-timed-controller branch from 1fc2f99 to 4279d03 Compare March 25, 2019 02:40

philwebb removed the for: team-attention An issue we'd like other members of the team to review label Mar 27, 2019

ttddyy force-pushed the configure-default-auto-timed-controller branch 2 times, most recently from 7850e60 to 0367236 Compare April 10, 2019 23:34

snicoll reviewed Apr 17, 2019

View reviewed changes

snicoll added the status: waiting-for-feedback We need additional information before we can continue label Apr 17, 2019

ttddyy force-pushed the configure-default-auto-timed-controller branch from 0367236 to 02715a3 Compare April 18, 2019 00:46

snicoll removed the status: waiting-for-feedback We need additional information before we can continue label Apr 30, 2019

snicoll self-assigned this May 1, 2019

snicoll removed this from the 2.2.x milestone May 1, 2019

snicoll added this to the 2.2.0.M3 milestone May 1, 2019

snicoll closed this in 8045bf1 May 1, 2019

snicoll added a commit that referenced this pull request May 1, 2019

Merge pull request #15988 from ttddyy

eb028fa

* pr/15988: Polish "Allow configuration of auto-timed metrics" Allow configuration of auto-timed metrics

ttddyy deleted the configure-default-auto-timed-controller branch May 1, 2019 06:44

snicoll added a commit that referenced this pull request May 14, 2019

Polish "Allow configuration of auto-timed metrics"

4d8df3c

This commit makes sure the "auto-time-requests" property is still available in a deprecated fashion. See gh-15988

philwebb mentioned this pull request May 30, 2019

Extract auto-timed interface for use in actuator #17026

Closed

		@@ -88,10 +92,31 @@ public WebMvcMetricsFilter(ApplicationContext context, MeterRegistry registry,
		*/
		public WebMvcMetricsFilter(MeterRegistry registry, WebMvcTagsProvider tagsProvider,

		@@ -64,10 +69,19 @@ public MetricsWebFilter(MeterRegistry registry, WebFluxTagsProvider tagsProvider

		public MetricsWebFilter(MeterRegistry registry, WebFluxTagsProvider tagsProvider,

Properties to set default configuration for auto-timed controller metrics #15988

Properties to set default configuration for auto-timed controller metrics #15988

Uh oh!

Conversation

ttddyy commented Feb 19, 2019

Uh oh!

wilkinsona left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ttddyy commented Feb 27, 2019

Uh oh!

snicoll left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ttddyy commented Mar 1, 2019

Uh oh!

wilkinsona commented Mar 20, 2019

Uh oh!

ttddyy commented Mar 25, 2019

Uh oh!

ttddyy commented Mar 27, 2019 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ttddyy commented Apr 11, 2019

Uh oh!

snicoll left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

ttddyy commented Apr 18, 2019

Uh oh!

snicoll commented May 1, 2019

Uh oh!

snicoll commented May 14, 2019

Uh oh!

Uh oh!

ttddyy commented Mar 27, 2019 •

edited

Loading