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: remove unused semconv packages and document #2182

Merged

Conversation

JamieDanielson
Copy link
Member

@JamieDanielson JamieDanielson commented May 7, 2024

Which problem is this PR solving?

Short description of the changes

  • For each of the following instrumentations, document that no semantic convention attributes are included in the instrumentation, and also uninstall @opentelemetry/semantic-conventions package that is unused:
    • @opentelemetry/instrumentation-lru-memoizer
    • @opentelemetry/instrumentation-dns
    • @opentelemetry/instrumentation-generic-pool
    • @opentelemetry/instrumentation-pino
    • @opentelemetry/instrumentation-winston
    • @opentelemetry/plugin-react-load
    • @opentelemetry/sampler-aws-xray

Note these are intentionally done in separate commits to make it easier to see each change, and also so I can easily move these into separate PRs if that seems easier to deal with. I combined for now because of the minimal impact overall but very open to feedback.

Also, part of this will need to be addressed in some follow-ups after discussion from #2170 ... namely that some of these are still emitting attributes, just not semantic-convention attributes. This does not address that in any way, only documenting the current state.

@trentm
Copy link
Contributor

trentm commented May 13, 2024

This could potentially add instr-bunyan. See #2195 (review)

@trentm
Copy link
Contributor

trentm commented May 14, 2024

The instr-bunyan update went in (#2195) without a README reference. @JamieDanielson If you like you could add the "This package does not currently generate" README blurb to instr-bunyan as well here. Else I can in a separate PR.

@JamieDanielson
Copy link
Member Author

The instr-bunyan update went in (#2195) without a README reference. @JamieDanielson If you like you could add the "This package does not currently generate" README blurb to instr-bunyan as well here. Else I can in a separate PR.

OK yeah I'll add that here real quick 👍

Copy link

codecov bot commented May 14, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 90.00%. Comparing base (dfb2dff) to head (807d152).
Report is 118 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #2182      +/-   ##
==========================================
- Coverage   90.97%   90.00%   -0.98%     
==========================================
  Files         146      140       -6     
  Lines        7492     6903     -589     
  Branches     1502     1453      -49     
==========================================
- Hits         6816     6213     -603     
- Misses        676      690      +14     

see 47 files with indirect coverage changes

@JamieDanielson JamieDanielson merged commit feb2720 into open-telemetry:main May 14, 2024
17 checks passed
@JamieDanielson JamieDanielson deleted the jamie.remove-unused-semconv branch May 14, 2024 19:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants