docs: clarify config-tracing and config-observability are separate tracing paths - #10626
Open
ogulcanaydogan wants to merge 1 commit into
Open
docs: clarify config-tracing and config-observability are separate tracing paths#10626ogulcanaydogan wants to merge 1 commit into
ogulcanaydogan wants to merge 1 commit into
Conversation
…acing paths config-tracing only drives the TaskRun and PipelineRun reconcilers' own tracer (pkg/tracing). config-observability's tracing-protocol, tracing-endpoint and tracing-sampling-rate keys instead configure the global OpenTelemetry provider used by the notification and cloud event reconcilers via otel.GetTracerProvider(). Neither reads the other's configuration, which was not documented anywhere and led to confusion in tektoncd#10276. Signed-off-by: Ogulcan Aydogan <ogulcanaydogan@gmail.com>
tekton-robot
added
the
do-not-merge/release-note-label-needed
tekton-robot
added
the
size/S
Collaborator
|
@khrm: The label(s) DetailsIn response to this:
Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. |
tekton-robot
added
kind/documentation
waveywaves
approved these changes
Aug 21, 2026
Collaborator
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: waveywaves The full list of commands accepted by this bot can be found here. The pull request process is described here DetailsNeeds approval from an approver in each of these files:
Approvers can indicate their approval by writing |
tekton-robot
added
the
approved
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
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.
Fixes #10276 (documentation portion, option 1 from the issue discussion).
config-tracingonly drives the TaskRun and PipelineRun reconcilers' own tracer (pkg/tracing).config-observability'stracing-protocol,tracing-endpointandtracing-sampling-ratekeys instead configure the global OpenTelemetry provider used by the notification and cloud event reconcilers viaotel.GetTracerProvider(). Neither reads the other's configuration, and that split wasn't documented anywhere, which is what led to the confusion in the issue.No behavior change, comments and docs only:
config/config-tracing.yaml: note that it only covers TaskRun/PipelineRun tracingconfig/config-observability.yaml: note that its tracing keys only cover notification/cloud event tracingdocs/developers/tracing.md: same clarification in proseTraced through the actual call sites to confirm before writing this up:
pkg/reconciler/pipelinerun/controller.goandpkg/reconciler/taskrun/controller.goboth build their tracer viapkg/tracing, which readsconfig-tracingpkg/reconciler/notifications/*andpkg/reconciler/events/cloudeventcallotel.GetTracerProvider()directly, which only gets configured byconfig-observability's keys through the vendoredknative.dev/pkg/observability/tracingLeft as a follow-up per @vdemeester's comment on the issue: whether to actually unify the two tracing paths is a bigger design question (the
credentialsSecretauth option inconfig-tracinghas no equivalent in the global provider yet), tracked separately from this docs fix.Release Notes