-
Notifications
You must be signed in to change notification settings - Fork 534
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
refactor(instr-graphql): use exported strings for attributes #2156
refactor(instr-graphql): use exported strings for attributes #2156
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #2156 +/- ##
==========================================
- Coverage 90.97% 90.12% -0.86%
==========================================
Files 146 142 -4
Lines 7492 6995 -497
Branches 1502 1475 -27
==========================================
- Hits 6816 6304 -512
- Misses 676 691 +15 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
Should we add some note in the README about this package not implementing any semantic convention at the moment?
I thought the absence of the section in the README was enough but I based on your comment I guess it would be better that all packages have a section about semconv |
That's my personal opinion 😄 Feel free to add one or resolve if you prefer the READMEs not to state it in this case |
Oh interesting! It looks like graphql semantic conventions do exist, and were recently added to the registry in semantic-conventions repo, though do not appear to exist in the schema itself yet unless I am missing it. Also seeing there was an issue opened (closed for stale) referencing unexpected attributes. So this does seem like something that we explicitly should state that we are not using semantic conventions here for graphql attributes... and a new issue should perhaps be opened to review that. I'm not clear on whether this would be included in the new generated semantic conventions if it doesn't exist in the schema yaml files, but it is something that appears to have expected conventions at this point. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
On #2182 I tried out this wording; if we like it we can use it here.
## Semantic Conventions
This package does not currently generate any attributes from semantic conventions.
Also as far as the other attributes that do seem like they should be pulled from semantic conventions and possibly updated as well... let's deal with that separately. This is strictly documenting the current state.
@JamieDanielson I've added your suggestion. Thanks :) |
Which problem is this PR solving?
Short description of the changes
SemanticAttributes.*
with exported stringsSEMATTRS_*
in test filesNote: I did not add the "semantic conventions" section in the readme file since this instrumentation is using it only in tests but not for span attribs