Skip to content

docs: add OpenTelemetry tracing example for SDK observability#443

Open
amankumar092 wants to merge 1 commit intokubeflow:mainfrom
amankumar092:patch-1
Open

docs: add OpenTelemetry tracing example for SDK observability#443
amankumar092 wants to merge 1 commit intokubeflow:mainfrom
amankumar092:patch-1

Conversation

@amankumar092
Copy link
Copy Markdown

Added a small documentation example showing how users can integrate OpenTelemetry tracing around Kubeflow SDK calls for better debugging and observability.

This aligns with improving SDK developer experience and monitoring workflows.

docs: add observability and tracing example in README

Signed-off-by: Aman Kumar <amankumar09227@gmail.com>
Copilot AI review requested due to automatic review settings March 31, 2026 07:30
@google-oss-prow
Copy link
Copy Markdown
Contributor

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please assign andreyvelich for approval. For more information see the Kubernetes Code Review Process.

The full list of commands accepted by this bot can be found here.

Details Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@github-actions
Copy link
Copy Markdown
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:

  • If you haven't already, please check out our Contributing Guide for repo-specific guidelines and the Kubeflow Contributor Guide for general community standards
  • Our team will review your PR soon! cc @kubeflow/kubeflow-sdk-team

Join the community:

Feel free to ask questions in the comments if you need any help or clarification!
Thanks again for contributing to Kubeflow! 🙏

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This pull request adds a new "Observability and Tracing" section to the README documentation, providing users with guidance on integrating OpenTelemetry for monitoring and debugging Kubeflow SDK operations.

Changes:

  • Added a new section titled "Observability and Tracing" documenting integration with OpenTelemetry
  • Included a code example showing how to wrap SDK calls with OpenTelemetry tracing spans
  • Positioned the section logically between "Local Development" and "Supported Kubeflow Projects"

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants