Add Observability section to CONTRIBUTING doc#7272
Merged
MrAlias merged 9 commits intoopen-telemetry:mainfrom Sep 4, 2025
Merged
Add Observability section to CONTRIBUTING doc#7272MrAlias merged 9 commits intoopen-telemetry:mainfrom
MrAlias merged 9 commits intoopen-telemetry:mainfrom
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
flc1125
reviewed
Aug 30, 2025
dmathieu
approved these changes
Sep 1, 2025
flc1125
approved these changes
Sep 1, 2025
pellared
approved these changes
Sep 1, 2025
Contributor
There was a problem hiding this comment.
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.
This was referenced Sep 1, 2025
dashpole
reviewed
Sep 2, 2025
dashpole
approved these changes
Sep 2, 2025
Contributor
dashpole
left a comment
There was a problem hiding this comment.
I love this. Can we incorporate any of this advice into our docs in opentelemetry.io?
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.
Adds an
Observabilitysection 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.