[rpc] Support Netty Logging at the network layer (alibaba#379)

Author: SteNicholas

fluss-rpc/src/main/java/com/alibaba/fluss/rpc/netty/NettyLogger.java

@@ -0,0 +1,84 @@
+/*
+ * Copyright (c) 2024 Alibaba Group Holding Ltd.
+ *
+ * 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
+ *
+ *      http://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 com.alibaba.fluss.rpc.netty;
+
+import com.alibaba.fluss.shaded.netty4.io.netty.buffer.ByteBuf;
+import com.alibaba.fluss.shaded.netty4.io.netty.buffer.ByteBufHolder;
+import com.alibaba.fluss.shaded.netty4.io.netty.channel.ChannelHandlerContext;
+import com.alibaba.fluss.shaded.netty4.io.netty.handler.logging.LogLevel;
+import com.alibaba.fluss.shaded.netty4.io.netty.handler.logging.LoggingHandler;
+
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+import java.io.IOException;
+import java.io.InputStream;
+
+/* This file is based on source code of Apache Spark Project (https://spark.apache.org/), licensed by the Apache
+ * Software Foundation (ASF) under the Apache License, Version 2.0. See the NOTICE file distributed with this work for
+ * additional information regarding copyright ownership. */
+
+/** A Netty logger that constructs a log handler depending on the log level. */
+public class NettyLogger {
+    private static final Logger logger = LoggerFactory.getLogger(NettyLogger.class);
+
+    /** A Netty LoggingHandler which does not dump the message contents. */
+    private static class NoContentLoggingHandler extends LoggingHandler {
+
+        NoContentLoggingHandler(Class<?> clazz, LogLevel level) {
+            super(clazz, level);
+        }
+
+        @Override
+        protected String format(ChannelHandlerContext ctx, String eventName, Object arg) {
+            if (arg instanceof ByteBuf) {
+                return format(ctx, eventName) + " " + ((ByteBuf) arg).readableBytes() + "B";
+            } else if (arg instanceof ByteBufHolder) {
+                return format(ctx, eventName)
+                        + " "
+                        + ((ByteBufHolder) arg).content().readableBytes()
+                        + "B";
+            } else if (arg instanceof InputStream) {
+                int available = -1;
+                try {
+                    available = ((InputStream) arg).available();
+                } catch (IOException ex) {
+                    // Swallow, but return -1 to indicate an error happened
+                }
+                return format(ctx, eventName, arg) + " " + available + "B";
+            } else {
+                return super.format(ctx, eventName, arg);
+            }
+        }
+    }
+
+    private final LoggingHandler loggingHandler;
+
+    public NettyLogger() {
+        if (logger.isTraceEnabled()) {
+            loggingHandler = new LoggingHandler(NettyLogger.class, LogLevel.TRACE);
+        } else if (logger.isDebugEnabled()) {
+            loggingHandler = new NoContentLoggingHandler(NettyLogger.class, LogLevel.DEBUG);
+        } else {
+            loggingHandler = null;
+        }
+    }
+
+    public LoggingHandler getLoggingHandler() {
+        return loggingHandler;
+    }
+}

fluss-rpc/src/main/java/com/alibaba/fluss/rpc/netty/client/ClientChannelInitializer.java

@@ -16,6 +16,7 @@
 
 package com.alibaba.fluss.rpc.netty.client;
 
+import com.alibaba.fluss.rpc.netty.NettyLogger;
 import com.alibaba.fluss.shaded.netty4.io.netty.channel.ChannelInitializer;
 import com.alibaba.fluss.shaded.netty4.io.netty.channel.socket.SocketChannel;
 import com.alibaba.fluss.shaded.netty4.io.netty.handler.codec.LengthFieldBasedFrameDecoder;
@@ -31,6 +32,8 @@ final class ClientChannelInitializer extends ChannelInitializer<SocketChannel> {
 
     private final int maxIdleTimeSeconds;
 
+    private static final NettyLogger nettyLogger = new NettyLogger();
+
     public ClientChannelInitializer(long maxIdleTimeSeconds) {
         checkArgument(maxIdleTimeSeconds <= Integer.MAX_VALUE, "maxIdleTimeSeconds too large");
         this.maxIdleTimeSeconds = (int) maxIdleTimeSeconds;
@@ -39,6 +42,9 @@ public ClientChannelInitializer(long maxIdleTimeSeconds) {
     @Override
     protected void initChannel(SocketChannel ch) {
         // NettyClientHandler will be added dynamically when connection is built
+        if (nettyLogger.getLoggingHandler() != null) {
+            ch.pipeline().addLast("loggingHandler", nettyLogger.getLoggingHandler());
+        }
         ch.pipeline()
                 .addLast(
                         "frameDecoder",

fluss-rpc/src/main/java/com/alibaba/fluss/rpc/netty/server/ServerChannelInitializer.java

@@ -16,6 +16,7 @@
 
 package com.alibaba.fluss.rpc.netty.server;
 
+import com.alibaba.fluss.rpc.netty.NettyLogger;
 import com.alibaba.fluss.shaded.netty4.io.netty.channel.ChannelInitializer;
 import com.alibaba.fluss.shaded.netty4.io.netty.channel.socket.SocketChannel;
 import com.alibaba.fluss.shaded.netty4.io.netty.handler.codec.LengthFieldBasedFrameDecoder;
@@ -32,6 +33,8 @@ final class ServerChannelInitializer extends ChannelInitializer<SocketChannel> {
     private final NettyServerHandler sharedServerHandler;
     private final int maxIdleTimeSeconds;
 
+    private static final NettyLogger nettyLogger = new NettyLogger();
+
     public ServerChannelInitializer(
             NettyServerHandler sharedServerHandler, long maxIdleTimeSeconds) {
         checkArgument(maxIdleTimeSeconds <= Integer.MAX_VALUE, "maxIdleTimeSeconds too large");
@@ -41,6 +44,9 @@ public ServerChannelInitializer(
 
     @Override
     protected void initChannel(SocketChannel ch) {
+        if (nettyLogger.getLoggingHandler() != null) {
+            ch.pipeline().addLast("loggingHandler", nettyLogger.getLoggingHandler());
+        }
         ch.pipeline()
                 .addLast(
                         "frameDecoder",