Skip to content

Commit 902b5d7

Browse files
Syed Muhammad OsamaSyed Muhammad Osama
authored andcommitted
Fix #48576: Clarify tracing dependency requirements
Signed-off-by: Syed Muhammad Osama <[email protected]>
1 parent 252b218 commit 902b5d7

File tree

1 file changed

+6
-1
lines changed
  • documentation/spring-boot-docs/src/docs/antora/modules/reference/pages/actuator

1 file changed

+6
-1
lines changed

documentation/spring-boot-docs/src/docs/antora/modules/reference/pages/actuator/tracing.adoc

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@
33

44
Spring Boot Actuator provides dependency management and auto-configuration for {url-micrometer-tracing-docs}[Micrometer Tracing], a facade for popular tracer libraries.
55

6+
NOTE: Spring Boot provides modular tracing support. Having `spring-boot-starter-actuator` on the classpath enables tracing infrastructure, but tracing auto-configuration is only activated when a supported tracing bridge and tracer implementation are also present.
7+
68
TIP: To learn more about Micrometer Tracing capabilities, see its {url-micrometer-tracing-docs}[reference documentation].
79

810

@@ -30,6 +32,9 @@ include-code::MyApplication[]
3032

3133
NOTE: There's an added logger statement in the `home()` method, which will be important later.
3234

35+
NOTE: Tracing is not enabled by adding `spring-boot-starter-actuator` alone. The following dependencies provide the tracing bridge and tracer implementation required for tracing auto-configuration.
36+
37+
3338
Now we have to add the following dependencies:
3439

3540
* `org.springframework.boot:spring-boot-starter-actuator`
@@ -112,7 +117,7 @@ WARNING: If you create the javadoc:org.springframework.web.client.RestTemplate[]
112117

113118
As Micrometer Tracer supports multiple tracer implementations, there are multiple dependency combinations possible with Spring Boot.
114119

115-
All tracer implementations need the `org.springframework.boot:spring-boot-starter-actuator` dependency.
120+
All tracer implementations need the `org.springframework.boot:spring-boot-starter-actuator` dependency. In addition, a tracing bridge and tracer implementation must be present on the classpath for tracing auto-configuration to be activated.
116121

117122

118123

0 commit comments

Comments
 (0)