Allow and document how users control SE tracing for OpenTelemetry using Helidon config under tracing (and telemetry)
#10791
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Resolves #10790
NOTE: Changed to a draft PR. The PR will also involve some coding changes, not just doc. The description below still describes doc-only changes. Updates to the changed files and the description coming soon.
Our SE tracing page contains details about using and configuring Jaeger and Zipkin tracing but not OpenTelemetry. Our code does not currently support using the
tracingconfig block if the project uses the Helidon OpenTelemetry tracing provider.This
docPR allows users to use thetracingconfig block adds to that page some dependency and config information.Note that the doc directs users choosing the OpenTelemetry tracing provider to use the recently-added
telemetryconfiguration feature, not thetracingconfig section.This is because the existing code does not support preparing OpenTelemetry using the
tracingconfig section, and that is because:telemetrysection is a far more functional approach.tracingconfig settings to control OpenTelemetry. Although that would provide superficial consistency with the other tracing providers (Jaeger and Zipkin), doing so would introduce problems:telemetry.TracerProvider.Builderprogrammatically or assign settings in thetracingconfig section, which the current code almost completely ignores.Note also that this PR does not change how users configure OTel behavior using MP. That is still done according to the MP Telemetry spec and not using our
telemetrysettings.Documentation
This is a doc PR.