feat(common): telemetry module for optional OpenTelemetry instrumentation`#437
Draft
aashvgit wants to merge 3 commits intokubeflow:mainfrom
Draft
feat(common): telemetry module for optional OpenTelemetry instrumentation`#437aashvgit wants to merge 3 commits intokubeflow:mainfrom
aashvgit wants to merge 3 commits intokubeflow:mainfrom
Conversation
…w#388 Signed-off-by: aashvgit <167199295+aashvgit@users.noreply.github.com>
Signed-off-by: aashvgit <167199295+aashvgit@users.noreply.github.com>
Signed-off-by: aashvgit <167199295+aashvgit@users.noreply.github.com>
Contributor
|
🎉 Welcome to the Kubeflow SDK! 🎉 Thanks for opening your first PR! We're happy to have you as part of our community 🚀 Here's what happens next:
Join the community:
Feel free to ask questions in the comments if you need any help or clarification! |
Contributor
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
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
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.
What this PR does / why we need it/summary:
Adds
kubeflow/common/telemetry.py— the shared foundation module foroptional OpenTelemetry instrumentation across all Kubeflow SDK clients.
This is a draft PR for GSoC 2026 Issue for project 7
Design Decisions
Zero overhead when disabled:
get_tracer()returns a_NoOpTracerwhen
opentelemetry-apiis not installed. No import errors, no exceptions.Opt-out via env var:
KUBEFLOW_TRACING_DISABLED=1disables allinstrumentation with no code changes required.
Configurable exporters:Supports
console,otlp, andnoneviaconfigure(exporter=...). OTLP endpoint configurable via env varKUBEFLOW_OTLP_ENDPOINT.Consistent naming:
SpanNamesandSpanAttributesconstants enforcenaming across all clients. Span names follow
kubeflow.sdk.<client>.<op>convention. Attributes follow OTel semantic conventions for GenAI workload.
Sampling: Configurable via
sample_rateparameter f(0.0–1.0).** Span Hierarchy (taking TrainerClient as example)**
kubeflow.sdk.trainer.train
kubeflow.sdk.trainer.create_trainjob [event: trainjob_submitted]
kubeflow.sdk.trainer.poll_status [× N per polling]
attributes: poll.iteration, kubeflow.trainer.status
Tests
10 unit tests following
TestCase + pytest.mark.parametrizepattern, All tests pass withoutopentelemetry-apiinstalled (no-op path).Fixes #
#164 as this is the foundation model
Checklist: