Added @WithSpan documentation for Java #1178
Conversation
There was a problem hiding this comment.
I think this is fine to incorporate for now, maybe some tweaks.
The main concern I have is that there's a bit of duplication. This article covers how to annotate the current span, which is fundamentally a manual instrumentation scenario.
It also covers the @WithSpan annotation, which is dope because it's a lightweight way to annotate any method anywhere. But that's also a manual instrumentation scenario.
That said, I understand that it exists as a means to do lightweight, supplementary instrumentation in concert with automatic instrumentation. That context is important and I wouldn't want to fold this into the existing manual instrumentation article without explaining that somehow.
That scenario may also be worth documenting in its own right as well. But I think it's unique to Java, at least for now.
|
@austinlparker and @chalin what are your thoughts and feels? |
Gaurang-Patel
changed the title
There was a problem hiding this comment.
Partly based in part on @cartermp's earlier remarks, I'd be inclined to leave automatic.md where it is, and add your new page as, say, annotations.md.
Thoughts @cartermp @austinlparker et all?
Also, see inline comments.
|
|
||
| public class MyClass { | ||
| @WithSpan | ||
| public void MyLogic(@SpanAttribute("parameter1") String parameter1, @SpanAttribute("parameter2") long parameter2) { |
There was a problem hiding this comment.
Consider adding a line break and indenting the arguments, that'll make the use of @SpanAttribute easier to see.
|
Thanks for the contribution @Gaurang-Patel! Please see my review comments. |
|
So, just to be clear, this is meant to replace https://github.com/open-telemetry/opentelemetry-java-instrumentation/blob/main/docs/manual-instrumentation.md, right? /cc @trask |
sound good to me 👍 cc: @open-telemetry/java-instrumentation-approvers |
@trask et all: see open-telemetry/opentelemetry-java-instrumentation#5516 |
Preview: https://deploy-preview-1178--opentelemetry.netlify.app/docs/instrumentation/java