-
Notifications
You must be signed in to change notification settings - Fork 174
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
Add semantic conventions for Elasticsearch client instrumentation #23
Conversation
Hi @lmolkova, we've discussed what changes to make based on your comments/questions. We agree it makes sense to have We are also assuming from the spec that there will also be an http span. Lastly, we've changed the A config option could also be used that allows users to opt-in for capturing bodies of every request. |
specification/trace/semantic_conventions/instrumentation/elasticsearch.md
Outdated
Show resolved
Hide resolved
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.
It would be great to get some insights on what is the intended span structure such conventions want to achieve. The initial paragraph about an HTTP span already existing is a bit unclear if an additional span for Elasticsearch should always be there, or attributes should be added to the underlying http span.
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.
@estolfo thank you for addressing my comments! Please also add a changelog entry.
specification/trace/semantic_conventions/instrumentation/elasticsearch.md
Outdated
Show resolved
Hide resolved
@lmolkova and @joaopgrassi I've updated the span name and attributes after a discussion with some more people internally.
What do you think? |
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.
Given you are the subject-matter expert here I think the span name change makes sense (makes more sense to customers). But the path_parts
change I'm not sure. I left a common with my concerns there
specification/trace/semantic_conventions/instrumentation/elasticsearch.md
Show resolved
Hide resolved
specification/trace/semantic_conventions/instrumentation/elasticsearch.md
Show resolved
Hide resolved
@open-telemetry/specs-semconv-maintainers could you please take a look? Thanks! |
specification/trace/semantic_conventions/instrumentation/elasticsearch.md
Outdated
Show resolved
Hide resolved
Generally looks good to me, but have some concerns around the implications of sensitive data handling. |
40a5fcb
to
0a4cd2f
Compare
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.
Depending when this merges, it might be affected by #143
I think @carlosalberto said in the SIG last night that he'd approve it and then we can merge. |
specification/trace/semantic_conventions/instrumentation/elasticsearch.md
Show resolved
Hide resolved
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
This PR originated as a PR in the opentelemetry-specification repo.
The outstanding discussion point from that PR was regarding the path forward for the existing Elasticsearch client instrumentations:
We are in the process of figuring out the path forward for the Java instrumentation and I'll update here when we have a plan.
Two instrumentations in progress that will use these semantic conventions: