docs: add OpenTelemetry tracing example for SDK observability#443
docs: add OpenTelemetry tracing example for SDK observability#443amankumar092 wants to merge 1 commit intokubeflow:mainfrom
Conversation
docs: add observability and tracing example in README Signed-off-by: Aman Kumar <amankumar09227@gmail.com>
|
[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 |
|
🎉 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! |
There was a problem hiding this comment.
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"
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.