Merge pull request #557 from PetrJanouch/1.7_logging_improvements

Logging improvements:

Author: ali-ince

driver/src/main/java/org/neo4j/driver/internal/async/inbound/ChunkDecoder.java

@@ -64,7 +64,7 @@ protected ByteBuf extractFrame( ChannelHandlerContext ctx, ByteBuf buffer, int i
         {
             int originalReaderIndex = buffer.readerIndex();
             int readerIndexWithChunkHeader = originalReaderIndex - INITIAL_BYTES_TO_STRIP;
-            int lengthWithChunkHeader = INITIAL_BYTES_TO_STRIP + buffer.readableBytes();
+            int lengthWithChunkHeader = INITIAL_BYTES_TO_STRIP + length;
             String hexDump = ByteBufUtil.hexDump( buffer, readerIndexWithChunkHeader, lengthWithChunkHeader );
             log.trace( "S: %s", hexDump );
         }

driver/src/main/java/org/neo4j/driver/internal/logging/ChannelActivityLogger.java

@@ -20,18 +20,21 @@
 
 import io.netty.channel.Channel;
 
+import org.neo4j.driver.internal.BoltServerAddress;
 import org.neo4j.driver.internal.async.ChannelAttributes;
 import org.neo4j.driver.v1.Logger;
 import org.neo4j.driver.v1.Logging;
 
 import static java.lang.String.format;
+import static org.neo4j.driver.internal.util.Format.valueOrEmpty;
 
 public class ChannelActivityLogger extends ReformattedLogger
 {
     private final Channel channel;
     private final String localChannelId;
 
     private String dbConnectionId;
+    private String serverAddress;
 
     public ChannelActivityLogger( Channel channel, Logging logging, Class<?> owner )
     {
@@ -54,12 +57,9 @@ protected String reformat( String message )
         }
 
         String dbConnectionId = getDbConnectionId();
+        String serverAddress = getServerAddress();
 
-        if ( localChannelId != null && dbConnectionId != null )
-        {
-            return format( "[0x%s][%s] %s", localChannelId, dbConnectionId, message );
-        }
-        return format( "[0x%s][] %s", localChannelId, message );
+        return format( "[0x%s][%s][%s] %s", localChannelId, valueOrEmpty( serverAddress ), valueOrEmpty( dbConnectionId ), message );
     }
 
     private String getDbConnectionId()
@@ -70,4 +70,16 @@ private String getDbConnectionId()
         }
         return dbConnectionId;
     }
+
+    private String getServerAddress()
+    {
+
+        if ( serverAddress == null )
+        {
+            BoltServerAddress serverAddress = ChannelAttributes.serverAddress( channel );
+            this.serverAddress = serverAddress != null ? serverAddress.toString() : null;
+        }
+
+        return serverAddress;
+    }
 }

driver/src/main/java/org/neo4j/driver/internal/util/Format.java

@@ -63,4 +63,12 @@ private static <V> String keyValueString( Entry<String,V> entry )
     {
         return String.format( "%s: %s", entry.getKey(), String.valueOf( entry.getValue() ) );
     }
+
+    /**
+     * Returns the submitted value if it is not null or an empty string if it is.
+     */
+    public static String valueOrEmpty( String value )
+    {
+        return value != null ? value : "";
+    }
 }

driver/src/test/java/org/neo4j/driver/internal/logging/ChannelActivityLoggerTest.java

@@ -21,6 +21,7 @@
 import io.netty.channel.embedded.EmbeddedChannel;
 import org.junit.jupiter.api.Test;
 
+import org.neo4j.driver.internal.BoltServerAddress;
 import org.neo4j.driver.internal.async.ChannelAttributes;
 import org.neo4j.driver.v1.Logging;
 
@@ -46,7 +47,19 @@ void shouldReformatWithChannelId()
 
         String reformatted = activityLogger.reformat( "Hello!" );
 
-        assertEquals( "[0x" + channel.id() + "][] Hello!", reformatted );
+        assertEquals( "[0x" + channel.id() + "][][] Hello!", reformatted );
+    }
+
+    @Test
+    void shouldReformatWithChannelIdAndServerAddress()
+    {
+        EmbeddedChannel channel = new EmbeddedChannel();
+        ChannelAttributes.setServerAddress( channel, new BoltServerAddress( "somewhere", 1234 ) );
+        ChannelActivityLogger activityLogger = new ChannelActivityLogger( channel, Logging.none(), getClass() );
+
+        String reformatted = activityLogger.reformat( "Hello!" );
+
+        assertEquals( "[0x" + channel.id() + "][somewhere:1234][] Hello!", reformatted );
     }
 
     @Test
@@ -58,6 +71,6 @@ void shouldReformatWithChannelIdAndConnectionId()
 
         String reformatted = activityLogger.reformat( "Hello!" );
 
-        assertEquals( "[0x" + channel.id() + "][bolt-12345] Hello!", reformatted );
+        assertEquals( "[0x" + channel.id() + "][][bolt-12345] Hello!", reformatted );
     }
 }