Add Observation instrumentation for gRPC client and server #3427
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
![sonatype-lift[bot]](https://avatars.githubusercontent.com/in/9843?s=60&v=4){kind=small}
...rc/main/java/io/micrometer/core/instrument/binder/grpc/ObservationGrpcServerInterceptor.java
Show resolved
Hide resolved
marcingrzejszczak
approved these changes
Sep 26, 2022
...rc/main/java/io/micrometer/core/instrument/binder/grpc/ObservationGrpcServerInterceptor.java
Outdated
Show resolved
Hide resolved
...rc/main/java/io/micrometer/core/instrument/binder/grpc/ObservationGrpcServerInterceptor.java
Show resolved
Hide resolved
|
|
...rc/main/java/io/micrometer/core/instrument/binder/grpc/ObservationGrpcServerInterceptor.java
Outdated
Show resolved
Hide resolved
...rc/main/java/io/micrometer/core/instrument/binder/grpc/ObservationGrpcClientInterceptor.java
Outdated
Show resolved
Hide resolved
| * | ||
| * @author Tadaya Tsuyukubo | ||
| */ | ||
| public class GrpcObservationSample { |
There was a problem hiding this comment.
Should we move this to micrometer-samples or keep it here?
I'm totally fine keeping it since it is quite simple.
There was a problem hiding this comment.
For now, keeping it here.
When all sample classes move to micrometer-samples, this goes as well.
| * @author Tadaya Tsuyukubo | ||
| * @since 1.10.0 | ||
| */ | ||
| public enum GrpcObservation implements ObservationDocumentation { |
There was a problem hiding this comment.
Since DocumentedObservation was renamed to ObservationDocumentation, should we rename GrpcObservation to to reflect that it is a documentation?
There was a problem hiding this comment.
Renamed to GrpcObservationDocumentation to align with existing other documentation classes.
Add Observation instrumentation for gRPC client and server.
...rc/main/java/io/micrometer/core/instrument/binder/grpc/ObservationGrpcServerInterceptor.java
Show resolved
Hide resolved
...rc/main/java/io/micrometer/core/instrument/binder/grpc/ObservationGrpcClientInterceptor.java
Show resolved
Hide resolved
izeye
added a commit
to izeye/micrometer
that referenced
this pull request
Oct 14, 2022
shakuzen
pushed a commit
that referenced
this pull request
Oct 17, 2022
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.
This PR adds two gRPC interceptors -
ObservationGrpcClientInterceptorandObservationGrpcServerInterceptor.I tried to match the data collecting from
Observationsimilar to Sleuth/Brave for spans and existing instrumentation(MetricsCollecting[Client|Server]Interceptor).For metrics, it is slightly different due to the underlying
Observationinfrastructure andDefaultMeterObservationHandler.The existing interceptors create these metrics:
grpc.client.requests.sent(Counter)grpc.client.responses.received(Counter)grpc.client.processing.duration(Timer)grpc.server.requests.sent(Counter)grpc.server.responses.received(Counter)grpc.server.processing.duration(Timer)The new
Observationbased interceptors creates metrics:grpc.client.received(Counter)grpc.client.sent(Counter)grpc.client(Timer)grpc.client.active(LongTaskTimer)grpc.server.received(Counter)grpc.server.sent(Counter)grpc.server(Timer)grpc.server.active(LongTaskTimer)The spans are nearly equivalent to what Brave provide.
The existing instrumentation does not have a test.
I have added one for the new interceptors that covers all GRPC use cases, 1:1, 1:stream, stream:1, stream:stream with success and failure patterns.