Skip to content

Commit d30f057

Browse files
committed
Polish "Improve documentation of tracing deps and config props"
See gh-34991
1 parent dfe60cb commit d30f057

File tree

1 file changed

+22
-7
lines changed
  • spring-boot-project/spring-boot-docs/src/docs/asciidoc/actuator

1 file changed

+22
-7
lines changed

spring-boot-project/spring-boot-docs/src/docs/asciidoc/actuator/tracing.adoc

Lines changed: 22 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -76,35 +76,50 @@ All tracer implementations need the `org.springframework.boot:spring-boot-starte
7676

7777
[[actuator.micrometer-tracing.tracer-implementations.otel-zipkin]]
7878
==== OpenTelemetry With Zipkin
79+
Tracing with OpenTelemetry and reporting to Zipkin requires the following dependencies:
7980

80-
* `io.micrometer:micrometer-tracing-bridge-otel` - which is needed to bridge the Micrometer Observation API to OpenTelemetry.
81-
* `io.opentelemetry:opentelemetry-exporter-zipkin` - which is needed to report traces to Zipkin.
81+
* `io.micrometer:micrometer-tracing-bridge-otel` - bridges the Micrometer Observation API to OpenTelemetry.
82+
* `io.opentelemetry:opentelemetry-exporter-zipkin` - reports traces to Zipkin.
83+
84+
Use the `management.zipkin.tracing.*` configuration properties to configure reporting to Zipkin.
8285

8386

8487

8588
[[actuator.micrometer-tracing.tracer-implementations.otel-wavefront]]
8689
==== OpenTelemetry With Wavefront
90+
Tracing with OpenTelemetry and reporting to Wavefront requires the following dependencies:
8791

88-
* `io.micrometer:micrometer-tracing-bridge-otel` - which is needed to bridge the Micrometer Observation API to OpenTelemetry.
89-
* `io.micrometer:micrometer-tracing-reporter-wavefront` - which is needed to report traces to Wavefront.
92+
* `io.micrometer:micrometer-tracing-bridge-otel` - bridges the Micrometer Observation API to OpenTelemetry.
93+
* `io.micrometer:micrometer-tracing-reporter-wavefront` - reports traces to Wavefront.
94+
95+
Use the `management.wavefront.*` configuration properties to configure reporting to Wavefront.
9096

9197

9298

9399
[[actuator.micrometer-tracing.tracer-implementations.brave-zipkin]]
94100
==== OpenZipkin Brave With Zipkin
101+
Tracing with OpenZipkin Brave and reporting to Zipkin requires the following dependencies:
95102

96-
* `io.micrometer:micrometer-tracing-bridge-brave` - which is needed to bridge the Micrometer Observation API to Brave.
97-
* `io.zipkin.reporter2:zipkin-reporter-brave` - which is needed to report traces to Zipkin.
98-
* Point the property `management.zipkin.tracing.endpoint` to the Zipkin server
103+
* `io.micrometer:micrometer-tracing-bridge-brave` - bridges the Micrometer Observation API to Brave.
104+
* `io.zipkin.reporter2:zipkin-reporter-brave` - reports traces to Zipkin.
99105

100106
NOTE: If your project doesn't use Spring MVC or Spring WebFlux, the `io.zipkin.reporter2:zipkin-sender-urlconnection` dependency is needed, too.
101107

108+
Use the `management.zipkin.tracing.*` configuration properties to configure reporting to Zipkin.
109+
110+
111+
102112
[[actuator.micrometer-tracing.tracer-implementations.brave-wavefront]]
103113
==== OpenZipkin Brave With Wavefront
114+
Tracing with OpenZipkin Brave and reporting to Wavefront requires the following dependencies:
104115

105116
* `io.micrometer:micrometer-tracing-bridge-brave` - which is needed to bridge the Micrometer Observation API to Brave.
106117
* `io.micrometer:micrometer-tracing-reporter-wavefront` - which is needed to report traces to Wavefront.
107118

119+
Use the `management.wavefront.*` configuration properties to configure reporting to Wavefront.
120+
121+
122+
108123
[[actuator.micrometer-tracing.micrometer-observation]]
109124
=== Integration with Micrometer Observation
110125

0 commit comments

Comments
 (0)