Skip to content

Improve documentation of tracing dependencies and configuration properties #34991

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 4 commits into from
Closed

Improve documentation of tracing dependencies and configuration properties #34991

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
28587f5
Document prop 'management.zipkin.tracing.endpoint'
RobertRad Apr 14, 2023
ffad654
Restructure section "Tracer implementations"
RobertRad Apr 17, 2023
1186578
Fix missing newlines
RobertRad Apr 17, 2023
970b581
Fix missing newlines
RobertRad Apr 17, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 25 additions & 14 deletions spring-boot-project/spring-boot-docs/src/docs/asciidoc/actuator/tracing.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,37 +72,48 @@ As Micrometer Tracer supports multiple tracer implementations, there are multipl

All tracer implementations need the `org.springframework.boot:spring-boot-starter-actuator` dependency.

[[actuator.micrometer-tracing.tracer-implementations.zipkin]]
==== Zipkin

* Point the property `management.zipkin.tracing.endpoint` to the Zipkin server

[[actuator.micrometer-tracing.tracer-implementations.otel-zipkin]]
==== OpenTelemetry With Zipkin
Needed dependencies:

[[actuator.micrometer-tracing.tracer-implementations.zipkin.otel]]
===== Zipkin & OpenTelemetry

* `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.

[[actuator.micrometer-tracing.tracer-implementations.zipkin.brave]]
===== Zipkin & Brave

* `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.

[[actuator.micrometer-tracing.tracer-implementations.otel-wavefront]]
==== OpenTelemetry With Wavefront
NOTE: If your project doesn't use Spring MVC or Spring WebFlux, the `io.zipkin.reporter2:zipkin-sender-urlconnection` dependency is needed, too.

* `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.

[[actuator.micrometer-tracing.tracer-implementations.wavefront]]
==== Wavefront

* Point the property `management.wavefront.uri` to the Wavefront server

[[actuator.micrometer-tracing.tracer-implementations.brave-zipkin]]
==== OpenZipkin Brave With Zipkin
Needed 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.
* `io.micrometer:micrometer-tracing-reporter-wavefront` - which is needed to report traces to Wavefront.

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

[[actuator.micrometer-tracing.tracer-implementations.brave-wavefront]]
==== OpenZipkin Brave With Wavefront
When using OpenTelemetry:

* `io.micrometer:micrometer-tracing-bridge-otel` - which is needed to bridge the Micrometer Observation API to OpenTelemetry.


When using Brave:

* `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.



[[actuator.micrometer-tracing.micrometer-observation]]
=== Integration with Micrometer Observation
Expand Down