From d30f0575f0a8848b15ed77595ea8d46e92d1773f Mon Sep 17 00:00:00 2001 From: Andy Wilkinson Date: Mon, 17 Apr 2023 19:41:46 +0100 Subject: [PATCH] Polish "Improve documentation of tracing deps and config props" See gh-34991 --- .../src/docs/asciidoc/actuator/tracing.adoc | 29 ++++++++++++++----- 1 file changed, 22 insertions(+), 7 deletions(-) diff --git a/spring-boot-project/spring-boot-docs/src/docs/asciidoc/actuator/tracing.adoc b/spring-boot-project/spring-boot-docs/src/docs/asciidoc/actuator/tracing.adoc index ee06829593a..5a1a1e41823 100644 --- a/spring-boot-project/spring-boot-docs/src/docs/asciidoc/actuator/tracing.adoc +++ b/spring-boot-project/spring-boot-docs/src/docs/asciidoc/actuator/tracing.adoc @@ -76,35 +76,50 @@ All tracer implementations need the `org.springframework.boot:spring-boot-starte [[actuator.micrometer-tracing.tracer-implementations.otel-zipkin]] ==== OpenTelemetry With Zipkin +Tracing with OpenTelemetry and reporting to Zipkin requires the following dependencies: -* `io.micrometer:micrometer-tracing-bridge-otel` - which is needed to bridge the Micrometer Observation API to OpenTelemetry. -* `io.opentelemetry:opentelemetry-exporter-zipkin` - which is needed to report traces to Zipkin. +* `io.micrometer:micrometer-tracing-bridge-otel` - bridges the Micrometer Observation API to OpenTelemetry. +* `io.opentelemetry:opentelemetry-exporter-zipkin` - reports traces to Zipkin. + +Use the `management.zipkin.tracing.*` configuration properties to configure reporting to Zipkin. [[actuator.micrometer-tracing.tracer-implementations.otel-wavefront]] ==== OpenTelemetry With Wavefront +Tracing with OpenTelemetry and reporting to Wavefront requires the following dependencies: -* `io.micrometer:micrometer-tracing-bridge-otel` - which is needed to bridge the Micrometer Observation API to OpenTelemetry. -* `io.micrometer:micrometer-tracing-reporter-wavefront` - which is needed to report traces to Wavefront. +* `io.micrometer:micrometer-tracing-bridge-otel` - bridges the Micrometer Observation API to OpenTelemetry. +* `io.micrometer:micrometer-tracing-reporter-wavefront` - reports traces to Wavefront. + +Use the `management.wavefront.*` configuration properties to configure reporting to Wavefront. [[actuator.micrometer-tracing.tracer-implementations.brave-zipkin]] ==== OpenZipkin Brave With Zipkin +Tracing with OpenZipkin Brave and reporting to Zipkin requires the following dependencies: -* `io.micrometer:micrometer-tracing-bridge-brave` - which is needed to bridge the Micrometer Observation API to Brave. -* `io.zipkin.reporter2:zipkin-reporter-brave` - which is needed to report traces to Zipkin. -* Point the property `management.zipkin.tracing.endpoint` to the Zipkin server +* `io.micrometer:micrometer-tracing-bridge-brave` - bridges the Micrometer Observation API to Brave. +* `io.zipkin.reporter2:zipkin-reporter-brave` - reports traces to Zipkin. NOTE: If your project doesn't use Spring MVC or Spring WebFlux, the `io.zipkin.reporter2:zipkin-sender-urlconnection` dependency is needed, too. +Use the `management.zipkin.tracing.*` configuration properties to configure reporting to Zipkin. + + + [[actuator.micrometer-tracing.tracer-implementations.brave-wavefront]] ==== OpenZipkin Brave With Wavefront +Tracing with OpenZipkin Brave and reporting to Wavefront requires the following dependencies: * `io.micrometer:micrometer-tracing-bridge-brave` - which is needed to bridge the Micrometer Observation API to Brave. * `io.micrometer:micrometer-tracing-reporter-wavefront` - which is needed to report traces to Wavefront. +Use the `management.wavefront.*` configuration properties to configure reporting to Wavefront. + + + [[actuator.micrometer-tracing.micrometer-observation]] === Integration with Micrometer Observation