spring/spring-boot
1
0
Fork 0
mirror of https://github.com/spring-projects/spring-boot.git synced 2026-09-17 12:09:16 +00:00
Code Issues Projects Releases Wiki Activity

Polish "Configure OpenTelemetry semantic conventions"

Browse Source 
See gh-49241

Signed-off-by: Andy Wilkinson <andy.wilkinson@broadcom.com>
This commit is contained in:
Andy Wilkinson
2026-09-17 10:18:17 +01:00
parent 7d43f31732
commit 02cf5b8d0f
13 changed files with 389 additions and 52 deletions
Download Patch File Download Diff File Expand all files Collapse all files
documentation/spring-boot-docs/src/docs/antora/modules/reference/pages/actuator/metrics.adoc
+4 -2
View File
@@ -731,7 +731,8 @@ NOTE: javadoc:org.springframework.jms.core.JmsClient[] and javadoc:org.springfra
Auto-configuration enables the instrumentation of all requests handled by Spring MVC controllers and functional handlers.
By default, metrics are generated with the name, `http.server.requests`.
You can customize the name by setting the configprop:management.observations.http.server.requests.name[] property.
If you are xref:actuator/observability.adoc#actuator.observability.semantic-conventions[using Micrometer's semantic conventions], set the configprop:management.observations.http.server.requests.name[] property to customize the name.
If you are using OpenTelemtry's semantic conventions, the name cannot be customized.
See the {url-spring-framework-docs}/integration/observability.html#observability.http-server.servlet[Spring Framework reference documentation for more information on produced observations].
@@ -751,7 +752,8 @@ To customize the filter, provide a javadoc:org.springframework.context.annotatio
Auto-configuration enables the instrumentation of all requests handled by Spring WebFlux controllers and functional handlers.
By default, metrics are generated with the name, `http.server.requests`.
You can customize the name by setting the configprop:management.observations.http.server.requests.name[] property.
If you are xref:actuator/observability.adoc#actuator.observability.semantic-conventions[using Micrometer's semantic conventions], set the configprop:management.observations.http.server.requests.name[] property to customize the name.
If you are using OpenTelemtry's semantic conventions, the name cannot be customized.
See the {url-spring-framework-docs}/integration/observability.html#observability.http-server.reactive[Spring Framework reference documentation for more information on produced observations].
documentation/spring-boot-docs/src/docs/antora/modules/reference/pages/actuator/observability.adoc
+15 -3
View File
@@ -101,14 +101,26 @@ In that case you can either disable the automatic instrumentation using xref:ref
[[actuator.observability.semantic-conventions]]
== Semantic Conventions
Semantic conventions govern things like metric names and tag names and values.
By default, the conventions defined by Micrometer and the various Spring projects are used.
To switch to OpenTelemetry's conventions, set configprop:management.observations.conventions[] to `open-telemetry`.
OpenTelemetry conventions are limited to those that are stable.
When using OpenTelemetry's conventions, note that certain properties for customizing meter names and the like will no longer take effect.
[[actuator.observability.opentelemetry]]
== OpenTelemetry Support
NOTE: There are several ways to support https://opentelemetry.io/[OpenTelemetry] in your application.
You can use the https://opentelemetry.io/docs/zero-code/java/agent/[OpenTelemetry Java Agent] or the https://opentelemetry.io/docs/zero-code/java/spring-boot-starter/[OpenTelemetry Spring Boot Starter],
which are supported by the OTel community; the metrics and traces use the semantic conventions defined by OTel libraries.
This documentation describes OpenTelemetry as officially supported by the Spring team, using Micrometer and the OTLP exporter;
the metrics and traces use the semantic conventions described in the Spring projects documentation, such as {url-spring-framework-docs}/integration/observability.html[Spring Framework].
which are supported by the OTel community.
In this case, the metrics and traces always use the semantic conventions defined by OTel libraries.
This documentation describes OpenTelemetry as officially supported by the Spring team, using Micrometer and the OTLP exporter.
In this case, the metrics and traces use the semantic conventions described in the Spring projects documentation, such as {url-spring-framework-docs}/integration/observability.html[Spring Framework], but can be <<actuator.observability.semantic-conventions, configured>> to use OpenTelemetry's stable conventions.
Spring Boot's actuator module includes basic support for OpenTelemetry.