Skip to content

Commit baf596d

Browse files
committed
Document double observations when using @timed etc.
Closes gh-44037
1 parent a4efcfe commit baf596d

File tree

4 files changed

+9
-12
lines changed

4 files changed

+9
-12
lines changed

buildSrc/src/main/resources/org/springframework/boot/build/antora/antora-asciidoc-attributes.properties

+1
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@ url-gradle-dsl=https://docs.gradle.org/current/dsl
2727
url-gradle-javadoc=https://docs.gradle.org/current/javadoc
2828
url-kotlin-docs-kotlin-plugin={url-kotlin-docs}/using-gradle.html
2929
url-micrometer-docs-concepts={url-micrometer-docs}/concepts
30+
url-micrometer-docs-observation={url-micrometer-docs}/observation
3031
url-micrometer-docs-implementations={url-micrometer-docs}/implementations
3132
url-native-build-tools-docs=https://graalvm.github.io/native-build-tools/{version-native-build-tools}
3233
url-native-build-tools-docs-gradle-plugin={url-native-build-tools-docs}/gradle-plugin.html

spring-boot-project/spring-boot-docs/src/docs/antora/modules/ROOT/pages/redirect.adoc

+2-2
Original file line numberDiff line numberDiff line change
@@ -1192,8 +1192,8 @@
11921192
* xref:reference:actuator/metrics.adoc#actuator.metrics.supported.system[#actuator.metrics.supported.system]
11931193
* xref:reference:actuator/metrics.adoc#actuator.metrics.supported.system[#production-ready-metrics-system]
11941194
* xref:reference:actuator/metrics.adoc#actuator.metrics.supported.tasks[#actuator.metrics.supported.tasks]
1195-
* xref:reference:actuator/metrics.adoc#actuator.metrics.supported.timed-annotation[#actuator.metrics.supported.timed-annotation]
1196-
* xref:reference:actuator/metrics.adoc#actuator.metrics.supported.timed-annotation[#production-ready-metrics-timed-annotation]
1195+
* xref:reference:actuator/observability.adoc#actuator.observability.annotations[#actuator.metrics.supported.timed-annotation]
1196+
* xref:reference:actuator/observability.adoc#actuator.observability.annotations[#production-ready-metrics-timed-annotation]
11971197
* xref:reference:actuator/metrics.adoc#actuator.metrics.supported.tomcat[#actuator.metrics.supported.tomcat]
11981198
* xref:reference:actuator/metrics.adoc#actuator.metrics.supported.tomcat[#production-ready-metrics-tomcat]
11991199
* xref:reference:actuator/metrics.adoc#actuator.metrics.supported[#actuator.metrics.supported]

spring-boot-project/spring-boot-docs/src/docs/antora/modules/reference/pages/actuator/metrics.adoc

-8
Original file line numberDiff line numberDiff line change
@@ -1124,14 +1124,6 @@ Metrics for Jetty's javadoc:org.eclipse.jetty.server.Connector[] instances are b
11241124

11251125

11261126

1127-
[[actuator.metrics.supported.timed-annotation]]
1128-
=== @Timed Annotation Support
1129-
1130-
To enable scanning of javadoc:io.micrometer.core.annotation.Timed[format=annotation] annotations, you will need to set the configprop:management.observations.annotations.enabled[] property to `true`.
1131-
Please refer to the {url-micrometer-docs-concepts}/timers.html#_the_timed_annotation[Micrometer documentation].
1132-
1133-
1134-
11351127
[[actuator.metrics.supported.redis]]
11361128
=== Redis Metrics
11371129

spring-boot-project/spring-boot-docs/src/docs/antora/modules/reference/pages/actuator/observability.adoc

+6-2
Original file line numberDiff line numberDiff line change
@@ -104,5 +104,9 @@ The next sections will provide more details about logging, metrics and traces.
104104
[[actuator.observability.annotations]]
105105
== Micrometer Observation Annotations support
106106

107-
To enable scanning of metrics and tracing annotations like javadoc:io.micrometer.core.annotation.Timed[format=annotation], javadoc:io.micrometer.core.annotation.Counted[format=annotation], javadoc:io.micrometer.core.aop.MeterTag[format=annotation] and javadoc:io.micrometer.tracing.annotation.NewSpan[format=annotation] annotations, you will need to set the configprop:management.observations.annotations.enabled[] property to `true`.
108-
This feature is supported Micrometer directly. Please refer to the {url-micrometer-docs-concepts}/timers.html#_the_timed_annotation[Micrometer] and {url-micrometer-tracing-docs}/api.html#_aspect_oriented_programming[Micrometer Tracing] reference docs.
107+
To enable scanning of observability annotations like javadoc:io.micrometer.observation.annotation.Observed[format=annotation], javadoc:io.micrometer.core.annotation.Timed[format=annotation], javadoc:io.micrometer.core.annotation.Counted[format=annotation], javadoc:io.micrometer.core.aop.MeterTag[format=annotation] and javadoc:io.micrometer.tracing.annotation.NewSpan[format=annotation] annotations, you need to set the configprop:management.observations.annotations.enabled[] property to `true`.
108+
This feature is supported by Micrometer directly.
109+
Please refer to the {url-micrometer-docs-concepts}/timers.html#_the_timed_annotation[Micrometer], {url-micrometer-docs-observation}/components.html#micrometer-observation-annotations[Micrometer Observation] and {url-micrometer-tracing-docs}/api.html#_aspect_oriented_programming[Micrometer Tracing] reference docs.
110+
111+
NOTE: When you annotate methods or classes which are already instrumented (for example xref:reference:actuator/metrics.adoc#actuator.metrics.supported.spring-data-repository[Spring Data repositories] or xref:reference:actuator/metrics.adoc#actuator.metrics.supported.spring-mvc[Spring MVC controllers]), you will get duplicate observations.
112+
In that case you can either disable the automatic instrumentation using xref:reference:actuator/observability.adoc#actuator.observability.preventing-observations[properties] or an javadoc:io.micrometer.observation.ObservationPredicate[] and rely on your annotations, or you can remove your annotation.

0 commit comments

Comments
 (0)