Skip to content
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

Design document for otelhttpconv package #6859

Open
wants to merge 15 commits into
base: main
Choose a base branch
from

Conversation

dmathieu
Copy link
Member

@dmathieu dmathieu commented Feb 28, 2025

This provides a design document for a new instrumentation, otelhttpconv that would serve as a meta instrumentation for all HTTP packages to more easily share their behavior.

@dmathieu dmathieu added the Skip Changelog Allow PR to succeed without requiring an addition to the CHANGELOG label Feb 28, 2025
Copy link

codecov bot commented Feb 28, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 75.5%. Comparing base (3ea6585) to head (77d428d).

Additional details and impacted files

Impacted file tree graph

@@           Coverage Diff           @@
##            main   #6859     +/-   ##
=======================================
- Coverage   75.5%   75.5%   -0.1%     
=======================================
  Files        207     207             
  Lines      19319   19319             
=======================================
- Hits       14601   14598      -3     
- Misses      4283    4285      +2     
- Partials     435     436      +1     

see 1 file with indirect coverage changes

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

@dmathieu dmathieu marked this pull request as ready for review March 4, 2025 13:15
@dmathieu dmathieu requested a review from a team as a code owner March 4, 2025 13:15
@dmathieu
Copy link
Member Author

dmathieu commented Mar 4, 2025

cc @akats7 @scorpionknifes as code owners of HTTP implementations

Copy link
Member

@XSAM XSAM left a comment

Choose a reason for hiding this comment

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

Could you add an example for a certain existing HTTP instrumentation to describe how otelhttpconv is actually being used in HTTP instrumentation? This could also give other authors more clues about how to leverage otelhttpconv to reduce code repetition.

@dmathieu
Copy link
Member Author

I've added a sample implementation of an http.Handler to show what it would look like for implementations.
I'm happy to provide a full implementation of otelhttpconv as well, to make this code work. But I'd rather do that when we're nearing consensus to avoid having to change things too many times.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Skip Changelog Allow PR to succeed without requiring an addition to the CHANGELOG
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants