-
Notifications
You must be signed in to change notification settings - Fork 517
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-connect): use exported strings for attributes #2154
refactor(instr-connect): use exported strings for attributes #2154
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #2154 +/- ##
==========================================
- Coverage 90.97% 90.47% -0.51%
==========================================
Files 146 148 +2
Lines 7492 7590 +98
Branches 1502 1591 +89
==========================================
+ Hits 6816 6867 +51
- Misses 676 723 +47
|
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
Left a general question about the current/future goal for the non-semantic attributes
| Attribute | Short Description | | ||
| ------------ | ---------------------------------- | | ||
| `http.route` | The matched route (path template). | | ||
|
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.
I wonder if it can be helpful to also enumerate the other, non-spec-compliant attributes that are emitted by this instrumentation, as a reference for users and for them to know what to expect when using this instrumentation.
There seems to be 2 custom attributes at the moment:
export enum AttributeNames {
CONNECT_TYPE = 'connect.type',
CONNECT_NAME = 'connect.name',
}
Do you think eventually we will need to either remove them or add them to the specs? Or eventually, each instrumentation is allowed to record extra attributes for which we also need some sort of documentation and stability guarantee?
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.
Do you think eventually we will need to either remove them or add them to the specs?
I'm not sure. I reached out to @joaopgrassi (semconv maintainer) to ask what the general rules are for instrumentations that emit non-semconv telemetry. It'll be brought up in the semconv SIG meeting today 🙂
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.
Thanks @pichlermarc and @joaopgrassi .
Any update on this issue?
I think it should not block the current PR. The non-semantic attributes can also be removed / added to docs in followup PRs once we get more guidelines.
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.
True we can probably open this as a new issue to look into and follow-up on.
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.
I've created #2170 for follow-up
Which problem is this PR solving?
Short description of the changes
SemanticAttributes.*
with exported stringsSEMATTRS_*