-
Notifications
You must be signed in to change notification settings - Fork 961
/
ObservationGrpcServerInterceptor.java
121 lines (103 loc) · 4.39 KB
/
ObservationGrpcServerInterceptor.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
/*
* Copyright 2022 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package io.micrometer.core.instrument.binder.grpc;
import io.grpc.*;
import io.grpc.Metadata.Key;
import io.grpc.MethodDescriptor.MethodType;
import io.grpc.ServerCall.Listener;
import io.micrometer.common.lang.Nullable;
import io.micrometer.observation.Observation;
import io.micrometer.observation.Observation.Scope;
import io.micrometer.observation.ObservationRegistry;
import java.util.Map;
import java.util.concurrent.ConcurrentHashMap;
import java.util.function.Supplier;
/**
* A gRPC server interceptor that works with {@link Observation}.
* <p>
* <b>Usage:</b>
* </p>
* <pre>
* Server server = ServerBuilder.forPort(8080)
* .intercept(new ObservationGrpcServerInterceptor(observationRegistry))
* .build();
* server.start()
* </pre> The instrumentation is based on the behavior of Spring Cloud Sleuth and Brave.
*
* @author Tadaya Tsuyukubo
* @since 1.10.0
*/
public class ObservationGrpcServerInterceptor implements ServerInterceptor {
private static final GrpcServerObservationConvention DEFAULT_CONVENTION = new DefaultGrpcServerObservationConvention();
private static final Map<String, Key<String>> KEY_CACHE = new ConcurrentHashMap<>();
private final ObservationRegistry registry;
@Nullable
private GrpcServerObservationConvention customConvention;
public ObservationGrpcServerInterceptor(ObservationRegistry registry) {
this.registry = registry;
}
@Override
public <ReqT, RespT> Listener<ReqT> interceptCall(ServerCall<ReqT, RespT> call, Metadata headers,
ServerCallHandler<ReqT, RespT> next) {
Supplier<GrpcServerObservationContext> contextSupplier = () -> {
GrpcServerObservationContext context = new GrpcServerObservationContext((carrier, keyName) -> {
Key<String> key = KEY_CACHE.computeIfAbsent(keyName,
(k) -> Key.of(keyName, Metadata.ASCII_STRING_MARSHALLER));
return carrier.get(key);
});
context.setCarrier(headers);
MethodDescriptor<ReqT, RespT> methodDescriptor = call.getMethodDescriptor();
String serviceName = methodDescriptor.getServiceName();
String methodName = methodDescriptor.getBareMethodName();
String fullMethodName = methodDescriptor.getFullMethodName();
MethodType methodType = methodDescriptor.getType();
if (serviceName != null) {
context.setServiceName(serviceName);
}
if (methodName != null) {
context.setMethodName(methodName);
}
context.setFullMethodName(fullMethodName);
context.setMethodType(methodType);
context.setAuthority(call.getAuthority());
return context;
};
Observation observation = GrpcObservationDocumentation.SERVER.observation(this.customConvention,
DEFAULT_CONVENTION, contextSupplier, this.registry);
if (observation.isNoop()) {
// do not instrument anymore
return next.startCall(call, headers);
}
Scope scope = observation.start().openScope();
ObservationGrpcServerCall<ReqT, RespT> serverCall = new ObservationGrpcServerCall<>(call, scope);
try {
Listener<ReqT> result = next.startCall(serverCall, headers);
return new ObservationGrpcServerCallListener<>(result, scope);
}
catch (Exception ex) {
scope.close();
observation.error(ex).stop();
throw ex;
}
}
/**
* Set a custom {@link GrpcServerObservationConvention}.
* @param customConvention a custom convention
*/
public void setCustomConvention(@Nullable GrpcServerObservationConvention customConvention) {
this.customConvention = customConvention;
}
}