-
Notifications
You must be signed in to change notification settings - Fork 1.2k
Add Observability section to CONTRIBUTING doc #7272
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #7272 +/- ##
=====================================
Coverage 82.9% 82.9%
=====================================
Files 265 265
Lines 24894 24894
=====================================
+ Hits 20641 20643 +2
+ Misses 3878 3876 -2
Partials 375 375 🚀 New features to boost your workflow:
|
f1f24fe
to
f5a5af0
Compare
f5a5af0
to
ee9661b
Compare
There was a problem hiding this 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 PR adds a comprehensive "Observability" section to the CONTRIBUTING.md documentation, providing detailed guidance for implementing self-observability in OpenTelemetry Go SDK components. This addresses issue #2547 by establishing best practices for instrumenting SDK components themselves.
Key changes:
- Adds extensive documentation on self-observability patterns and best practices
- Provides code examples for proper instrumentation setup, performance optimization, and testing
- Establishes guidelines for semantic conventions compliance and error handling
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I love this. Can we incorporate any of this advice into our docs in opentelemetry.io?
Adds an
Observability
section to the CONTRIBUTING.md documentation. This is a follow-up to issue #2547 (comment) and provides guidance for implementing self-observability in OpenTelemetry Go SDK components.