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

docs(instr-http): document semantic conventions and attributes in use #4587

Merged

Conversation

JamieDanielson
Copy link
Member

Which problem is this PR solving?

I didn't see a specific issue for this, so realizing there should probably be another issue similar to open-telemetry/opentelemetry-js-contrib#1778 in this repo, for the instrumentations within.

This is intended to let folks know what version of semantic conventions are in use as well as the attributes exported in the instrumentation. This will make it easier to update to later versions when ready (see tracking issue #4572).

Short description of the changes

  • In the README for http instrumentation, add version of Semantic Conventions used as well as a table of keys and values. I kept the "1.22+" because even though the numbered version will change with each release, right now it's effective in 1.22+ that contains the exported string keys. When we have a new semantic convention package with new attributes, we can adjust that.

Type of change

Please delete options that are not relevant.

  • This change requires a documentation update

How Has This Been Tested?

  • n/a

Checklist:

  • Followed the style guidelines of this project
  • Documentation has been updated

@JamieDanielson JamieDanielson requested a review from a team March 26, 2024 21:39
Copy link

codecov bot commented Mar 26, 2024

Codecov Report

Merging #4587 (fd72c9f) into main (f6a075b) will decrease coverage by 0.02%.
The diff coverage is n/a.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #4587      +/-   ##
==========================================
- Coverage   92.84%   92.83%   -0.02%     
==========================================
  Files         328      328              
  Lines        9494     9494              
  Branches     2040     2040              
==========================================
- Hits         8815     8814       -1     
- Misses        679      680       +1     

see 1 file with indirect coverage changes

@pichlermarc pichlermarc merged commit 1a0fb4f into open-telemetry:main Mar 28, 2024
17 checks passed
@JamieDanielson JamieDanielson deleted the jamie.http-semconv-readme branch March 28, 2024 18:04
Zirak pushed a commit to Zirak/opentelemetry-js that referenced this pull request Sep 14, 2024
…open-telemetry#4587)

* docs(instr-http): document semantic conventions in use

* add changelog entry

---------

Co-authored-by: Marc Pichler <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants