Document Instrumenter API #4544
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
mateuszrzeszutek
requested review from
anuraaga,
iNikem,
jkwatson,
laurit,
pavolloffay,
trask and
tylerbenson
as code owners
iNikem
reviewed
Nov 1, 2021
laurit
reviewed
Nov 1, 2021
laurit
reviewed
Nov 1, 2021
laurit
reviewed
Nov 1, 2021
laurit
reviewed
Nov 1, 2021
theletterf
suggested changes
Nov 2, 2021
mateuszrzeszutek
force-pushed
the
instrumenter-docs
branch
from
dafadff to
24f1cad
Compare
Co-authored-by: Fabrizio Ferri-Benedetti <[email protected]> Co-authored-by: Nikita Salnikov-Tarnovski <[email protected]> Co-authored-by: Lauri Tulmin <[email protected]>
mateuszrzeszutek
force-pushed
the
instrumenter-docs
branch
from
24f1cad to
0d787ef
Compare
trask
approved these changes
Nov 4, 2021
Comment on lines
+87
to
+94
| try (Scope scope = context.makeCurrent()) { | ||
| Response response = actualMethod(request); | ||
| instrumenter.end(context, request, response, null); | ||
| return response; | ||
| } catch (Throwable error) { | ||
| instrumenter.end(context, request, null, error); | ||
| throw error; | ||
| } |
There was a problem hiding this comment.
@anuraaga did we discuss this previously?
@mateuszrzeszutek this might be too weird for doc anyways...
Suggested change
| try (Scope scope = context.makeCurrent()) { | |
| Response response = actualMethod(request); | |
| instrumenter.end(context, request, response, null); | |
| return response; | |
| } catch (Throwable error) { | |
| instrumenter.end(context, request, null, error); | |
| throw error; | |
| } | |
| Response response = null; | |
| Throwable error = null; | |
| try (Scope scope = context.makeCurrent()) { | |
| response = actualMethod(request); | |
| return response; | |
| } catch (Throwable t) { | |
| error = t; | |
| throw t; | |
| } finally { | |
| instrumenter.end(context, request, response, error); | |
| } |
There was a problem hiding this comment.
Well - our docs should reflect our practice :) I think ending without the scope active is generally better but we haven't made such a change ourselves really
There was a problem hiding this comment.
👍 opened #4596 to discuss/implement and we can update the doc later if we make the change
There was a problem hiding this comment.
I'll merge this PR as it is -- the doc can be updated as part of #4596 later, when all instrumentations follow that pattern.
Comment on lines
+413
to
+421
| The sample `ContextCustomizer` listed above inserts an additional `InProcessingAttributesHolder` to | ||
| the `Context` before it is returned from the `Instrumenter#start()` method. | ||
| The `InProcessingAttributesHolder` class, as its name implies, may be used to keep track of | ||
| attributes that are not available on request start or end - for example, if the instrumented library | ||
| exposes important information only during the processing. The holder class can be looked up from the | ||
| current `Context` and filled in with that information between the instrumented operation start and | ||
| end. It can be later passed as `RESPONSE` type (or a part of it) to the `Instrumenter#end()` method | ||
| so that the configured `AttributesExtractor` can process the collected information and turn it into | ||
| telemetry attributes. |
Co-authored-by: Trask Stalnaker <[email protected]>
RashmiRam
pushed a commit
to RashmiRam/opentelemetry-auto-instr-java
that referenced
this pull request
May 23, 2022
* Document Instrumenter API * Apply suggestions from code review Co-authored-by: Fabrizio Ferri-Benedetti <[email protected]> Co-authored-by: Nikita Salnikov-Tarnovski <[email protected]> Co-authored-by: Lauri Tulmin <[email protected]> * reformat and code review comments * code review comments * Apply suggestions from code review Co-authored-by: Trask Stalnaker <[email protected]> * formatting Co-authored-by: Fabrizio Ferri-Benedetti <[email protected]> Co-authored-by: Nikita Salnikov-Tarnovski <[email protected]> Co-authored-by: Lauri Tulmin <[email protected]> Co-authored-by: Trask Stalnaker <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Resolves #4280 (together with the previous #4443 PR)
CC @theletterf