Skip to content

Conversation

MrAlias
Copy link
Contributor

@MrAlias MrAlias commented Aug 29, 2025

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.

@MrAlias MrAlias added the Skip Changelog PRs that do not require a CHANGELOG.md entry label Aug 29, 2025
Copy link

codecov bot commented Aug 29, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 82.9%. Comparing base (4107421) to head (6dd354e).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files

Impacted file tree graph

@@          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           

see 2 files with indirect coverage changes

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@MrAlias MrAlias force-pushed the obs-best-practice branch 2 times, most recently from f1f24fe to f5a5af0 Compare August 29, 2025 19:30
@MrAlias MrAlias force-pushed the obs-best-practice branch from f5a5af0 to ee9661b Compare August 29, 2025 19:33
@MrAlias MrAlias added the documentation Provides helpful information label Aug 29, 2025
@MrAlias MrAlias mentioned this pull request Aug 29, 2025
@MrAlias MrAlias marked this pull request as ready for review August 29, 2025 19:41
@pellared pellared requested a review from Copilot September 1, 2025 11:14
Copy link
Contributor

@Copilot 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 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.

Copy link
Contributor

@dashpole dashpole left a 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?

@MrAlias MrAlias merged commit a5dcd68 into open-telemetry:main Sep 4, 2025
33 checks passed
@MrAlias MrAlias deleted the obs-best-practice branch September 4, 2025 16:11
@MrAlias MrAlias added this to the v1.39.0 milestone Oct 14, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Provides helpful information Skip Changelog PRs that do not require a CHANGELOG.md entry

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants