[英]Intercepting/Logging requests and Responses in GRPC
I'm developing a chat app using GRPC in which the server receives information from the client and sends it back out to all the clients connected to it. 我正在使用GRPC开发一个聊天应用程序,其中服务器从客户端接收信息并将其发送回连接到它的所有客户端。 For this, I've used Saturnism's chat-example as a reference.
为此,我使用Saturnism的 聊天示例作为参考。 I've replicated the code, the code compiles and runs but the server supposedly never receives any requests from client.
我已经复制了代码,代码编译并运行,但服务器应该永远不会收到客户端的任何请求。
My question is: 我的问题是:
WingokuServer.java WingokuServer.java
public class WingokuServer {
public static void main(String[] args) throws IOException, InterruptedException {
Server server = ServerBuilder.forPort(8091)
.intercept(recordRequestHeadersInterceptor())
.addService(new WingokuServiceImpl())
.build();
System.out.println("Starting server...");
server.start();
System.out.println("Server started!");
server.awaitTermination();
}
WingokuServerSideServiceImplementation: WingokuServerSideServiceImplementation:
public class WingokuServiceImpl extends WingokuServiceGrpc.WingokuServiceImplBase {
private static Set<StreamObserver<Response>> observers =
Collections.newSetFromMap(new ConcurrentHashMap<>());
public WingokuServiceImpl() {
System.out.println("WingokuServiceImp");
}
@Override
public StreamObserver<Request> messages(StreamObserver<Response> responseObserver) {
System.out.println("messages");
observers.add(responseObserver);
return new StreamObserver<Request>() {
@Override
public void onNext(Request request) {
System.out.println("Server onNext: ");
System.out.println("request from client is: "+ request.getRequestMessage());
Response response = Response.newBuilder().setResponseMessage("new Message From server at time: "+ System.nanoTime()).build();
for (StreamObserver<Response> observer : observers) {
observer.onNext(response);
}
}
@Override
public void onError(Throwable throwable) {
System.out.println("Server onError: ");
throwable.printStackTrace();
}
@Override
public void onCompleted() {
observers.remove(responseObserver);
System.out.println("Server onCompleted ");
}
};
}
}
WingokuClient: WingokuClient:
public class WingokuClient {
public static void main(String[] args) {
ManagedChannel channel = ManagedChannelBuilder.forAddress("localhost", 8091).usePlaintext(true).build();
WingokuServiceGrpc.WingokuServiceStub asyncStub = WingokuServiceGrpc.newStub(channel);
StreamObserver<Request> requestStreamObserver = asyncStub.messages(new StreamObserver<Response>() {
@Override
public void onNext(Response response) {
System.out.println("Client onNext");
System.out.println("REsponse from server is: "+ response.getResponseMessage());
}
@Override
public void onError(Throwable throwable) {
System.out.println("Client onError");
throwable.printStackTrace();
}
@Override
public void onCompleted() {
System.out.println("Client OnComplete");
}
});
requestStreamObserver.onNext(Request.newBuilder().setRequestMessage("Message From Client").build());
requestStreamObserver.onCompleted();
channel.shutdown();
System.out.println("exiting client");
}
}
Edit: 编辑:
There is nothing wrong with the code. 代码没有任何问题。 It works.
有用。 I just needed to add awaitTermination to the client's channel because without it just closes the connection between client and server instantly, probably even before the requests go out of the client onto the network.
我只需要将awaitTermination添加到客户端的通道,因为没有它只是立即关闭客户端和服务器之间的连接,甚至可能在请求从客户端进入网络之前。 That's why the server never received any requests.
这就是服务器从未收到任何请求的原因。
However my question for enabling verbose logging and/or adding some sort of interceptor to the server side still remains unanswered. 但是我的问题是,启用详细日志记录和/或向服务器端添加某种拦截器仍然没有答案。 So I'm looking forward to getting some pointers from experts here.
所以我期待在这里得到专家的一些指示。
You can turn on the frame logging in the Netty transport. 您可以打开Netty传输中的帧日志记录。 First, create a file called
logging.properties
. 首先,创建一个名为
logging.properties
的文件。 In the file put the following contents: 在文件中输入以下内容:
handlers=java.util.logging.ConsoleHandler
io.grpc.netty.level=FINE
java.util.logging.ConsoleHandler.level=FINE
java.util.logging.ConsoleHandler.formatter=java.util.logging.SimpleFormatter
Then start up the Java binary with the jvm flag -Djava.util.logging.config.file=logging.properties
然后使用jvm标志
-Djava.util.logging.config.file=logging.properties
启动Java二进制文件
Also, if you would like to print the message contents or headers as seen on the server, you can create a ServerInterceptor: https://grpc.io/grpc-java/javadoc/io/grpc/ServerInterceptor.html 此外,如果要打印服务器上显示的消息内容或标题,可以创建ServerInterceptor: https ://grpc.io/grpc-java/javadoc/io/grpc/ServerInterceptor.html
You can look at the examples directory on how ServerInterceptor and ClientInterceptor work. 您可以查看示例目录,了解ServerInterceptor和ClientInterceptor的工作方式。 There is not pre-existing interceptor that logs the network events.
没有预先存在的拦截器记录网络事件。
I found a way to log request and response in both server and client sides by using the Interceptor, it makes the code cleaner. 我找到了一种通过使用Interceptor在服务器端和客户端记录请求和响应的方法,它使代码更清晰。 It is also possible to use sleuth for the tracing as well.
也可以使用侦探来进行追踪。
Please use spring: 请使用弹簧:
implementation 'io.github.lognet:grpc-spring-boot-starter'
Server part 服务器部分
You can then use the GRpcGlobalInterceptor annotation 然后,您可以使用GRpcGlobalInterceptor注释
import io.grpc.Metadata;
import io.grpc.MethodDescriptor;
import io.grpc.ServerCall;
import io.grpc.ServerCallHandler;
import io.grpc.ServerInterceptor;
import io.grpc.Status;
import org.lognet.springboot.grpc.GRpcGlobalInterceptor;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import static io.grpc.Metadata.ASCII_STRING_MARSHALLER;
@GRpcGlobalInterceptor
public class GrpcInterceptor implements ServerInterceptor {
private Logger logger = LoggerFactory.getLogger(this.getClass());
public static final Metadata.Key<String> TRACE_ID_KEY = Metadata.Key.of("traceId", ASCII_STRING_MARSHALLER);
@Override
public <M, R> ServerCall.Listener<M> interceptCall(
ServerCall<M, R> call, Metadata headers, ServerCallHandler<M, R> next) {
String traceId = headers.get(TRACE_ID_KEY);
// TODO: Add traceId to sleuth
logger.warn("traceId from client: {}. TODO: Add traceId to sleuth", traceId);
GrpcServerCall grpcServerCall = new GrpcServerCall(call);
ServerCall.Listener listener = next.startCall(grpcServerCall, headers);
return new GrpcForwardingServerCallListener<M>(call.getMethodDescriptor(), listener) {
@Override
public void onMessage(M message) {
logger.info("Method: {}, Message: {}", methodName, message);
super.onMessage(message);
}
};
}
private class GrpcServerCall<M, R> extends ServerCall<M, R> {
ServerCall<M, R> serverCall;
protected GrpcServerCall(ServerCall<M, R> serverCall) {
this.serverCall = serverCall;
}
@Override
public void request(int numMessages) {
serverCall.request(numMessages);
}
@Override
public void sendHeaders(Metadata headers) {
serverCall.sendHeaders(headers);
}
@Override
public void sendMessage(R message) {
logger.info("Method: {}, Response: {}", serverCall.getMethodDescriptor().getFullMethodName(), message);
serverCall.sendMessage(message);
}
@Override
public void close(Status status, Metadata trailers) {
serverCall.close(status, trailers);
}
@Override
public boolean isCancelled() {
return serverCall.isCancelled();
}
@Override
public MethodDescriptor<M, R> getMethodDescriptor() {
return serverCall.getMethodDescriptor();
}
}
private class GrpcForwardingServerCallListener<M> extends io.grpc.ForwardingServerCallListener.SimpleForwardingServerCallListener<M> {
String methodName;
protected GrpcForwardingServerCallListener(MethodDescriptor method, ServerCall.Listener<M> listener) {
super(listener);
methodName = method.getFullMethodName();
}
}
}
Client part 客户端部分
Interceptor: 拦截器:
import io.grpc.CallOptions;
import io.grpc.Channel;
import io.grpc.ClientCall;
import io.grpc.ClientInterceptor;
import io.grpc.Metadata;
import io.grpc.MethodDescriptor;
import io.grpc.Status;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.stereotype.Component;
import java.util.concurrent.TimeUnit;
import static io.grpc.Metadata.ASCII_STRING_MARSHALLER;
@Component
public class BackendInterceptor implements ClientInterceptor {
private Logger logger = LoggerFactory.getLogger(this.getClass());
public static final Metadata.Key<String> TRACE_ID_KEY = Metadata.Key.of("traceId", ASCII_STRING_MARSHALLER);
@Override
public <M, R> ClientCall<M, R> interceptCall(
final MethodDescriptor<M, R> method, CallOptions callOptions, Channel next) {
return new BackendForwardingClientCall<M, R>(method,
next.newCall(method, callOptions.withDeadlineAfter(10000, TimeUnit.MILLISECONDS))) {
@Override
public void sendMessage(M message) {
logger.info("Method: {}, Message: {}", methodName, message);
super.sendMessage(message);
}
@Override
public void start(Listener<R> responseListener, Metadata headers) {
// TODO: Use the sleuth traceId instead of 999
headers.put(TRACE_ID_KEY, "999");
BackendListener<R> backendListener = new BackendListener<>(methodName, responseListener);
super.start(backendListener, headers);
}
};
}
private class BackendListener<R> extends ClientCall.Listener<R> {
String methodName;
ClientCall.Listener<R> responseListener;
protected BackendListener(String methodName, ClientCall.Listener<R> responseListener) {
super();
this.methodName = methodName;
this.responseListener = responseListener;
}
@Override
public void onMessage(R message) {
logger.info("Method: {}, Response: {}", methodName, message);
responseListener.onMessage(message);
}
@Override
public void onHeaders(Metadata headers) {
responseListener.onHeaders(headers);
}
@Override
public void onClose(Status status, Metadata trailers) {
responseListener.onClose(status, trailers);
}
@Override
public void onReady() {
responseListener.onReady();
}
}
private class BackendForwardingClientCall<M, R> extends io.grpc.ForwardingClientCall.SimpleForwardingClientCall<M, R> {
String methodName;
protected BackendForwardingClientCall(MethodDescriptor<M, R> method, ClientCall delegate) {
super(delegate);
methodName = method.getFullMethodName();
}
}
}
Add the interceptor to the channel: 将拦截器添加到通道:
ManagedChannel managedChannel = ManagedChannelBuilder
.forAddress(_URL_, _PORT_).usePlaintext().intercept(backendInterceptor).build();
声明:本站的技术帖子网页,遵循CC BY-SA 4.0协议,如果您需要转载,请注明本站网址或者原文地址。任何问题请咨询:yoyou2525@163.com.