Abstraction for instrumentating with a Timer or Observation (optionally) #3357
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
…tion (optionally) We have a lot of existing instrumentations with Timer that are good candidates to be rewritten with the Observation API for added extensibility. However, we cannot break compatibility for existing users by requiring an ObservationRegistry for each instrumentation. We will want to add an option to configure an ObservationRegistry on the builder for the instrumentation or as an additional constructor if there isn't a builder. Instrumentation should still work as before without providing an ObservationRegistry. This can be handled in each instrumentation, but this added class ObservationOrTimerCompatibleInstrumentation is intended to make it easier to support this case where instrumentation may be done with a Timer or Observation depending on whether an ObservationRegistry is available. By having a common abstraction for this, we can hopefully make supporting Observation in our existing instrumentations easier, and also avoid adding overhead to instrumentation by avoiding instantiating things for Observation when a Timer is used (and the opposite situation).
shakuzen
added
enhancement
![sonatype-lift[bot]](https://avatars.githubusercontent.com/in/9843?s=60&v=4){kind=small}
...a/io/micrometer/core/instrument/observation/ObservationOrTimerCompatibleInstrumentation.java
Show resolved
Hide resolved
...a/io/micrometer/core/instrument/observation/ObservationOrTimerCompatibleInstrumentation.java
Show resolved
Hide resolved
...a/io/micrometer/core/instrument/observation/ObservationOrTimerCompatibleInstrumentation.java
Outdated
Show resolved
Hide resolved
| * @param <RES> type of the response | ||
| */ | ||
| public <RES> void setResponse(RES response) { | ||
| if (observationRegistry.isNoop() || !(context instanceof RequestReplySenderContext)) { |
There was a problem hiding this comment.
What about RequestReplyReceiverContext ? We have the response there too?
There was a problem hiding this comment.
Good catch. I had only tried this with the Apache HTTP client instrumentation, which is why I probably only thought of this. I expect we'll catch other things and add to it as we use this in more places.
Do you think it makes sense to extract the response-related methods to an interface so we could check for that here and just cast to that?
There was a problem hiding this comment.
Sure, that's a good idea
There was a problem hiding this comment.
I'll follow-up with this in a separate pull request. I've left a TODO comment for now.
1 task
jonatan-ivanov
approved these changes
Aug 18, 2022
shakuzen
changed the title
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.
We have a lot of existing instrumentations with Timer that are good candidates to be rewritten with the Observation API for added extensibility. However, we cannot break compatibility for existing users by requiring an ObservationRegistry for each instrumentation. We will want to add an option to configure an ObservationRegistry on the builder for the instrumentation or as an additional constructor if there isn't a builder. Instrumentation should still work as before without providing an ObservationRegistry. This can be handled in each instrumentation, but this added class ObservationOrTimerCompatibleInstrumentation is intended to make it easier to support this case where instrumentation may be done with a Timer or Observation depending on whether an ObservationRegistry is available. By having a common abstraction for this, we can hopefully make supporting Observation in our existing instrumentations easier, and also avoid adding overhead to instrumentation by avoiding instantiating things for Observation when a Timer is used (and the opposite situation).