Add NetworkLogging config enabled property.

Author: vietj

vertx-core/src/main/java/io/vertx/core/http/impl/HttpClientBuilderInternal.java

@@ -17,6 +17,7 @@
 import io.vertx.core.internal.http.HttpClientInternal;
 import io.vertx.core.internal.net.NetClientInternal;
 import io.vertx.core.net.ClientSSLOptions;
+import io.vertx.core.net.NetworkLogging;
 import io.vertx.core.net.ProxyOptions;
 import io.vertx.core.net.endpoint.LoadBalancer;
 import io.vertx.core.net.AddressResolver;
@@ -257,12 +258,13 @@ public HttpClientAgent build() {
         .protocol("http")
         .sslOptions(sslOptions)
         .build();
+      NetworkLogging networkLogging = co.getTcpConfig().getNetworkLogging();
       transport = new TcpHttpClientTransport(
         tcpClient,
         co.getTracingPolicy(),
         co.isDecompressionEnabled(),
-        co.getTcpConfig().getNetworkLogging() != null,
-        co.getTcpConfig().getNetworkLogging() != null ? co.getTcpConfig().getNetworkLogging().getDataFormat() : null,
+        networkLogging != null && networkLogging.isEnabled(),
+        networkLogging != null ? networkLogging.getDataFormat() : null,
         co.isForceSni(),
         supportedVersions.contains(HttpVersion.HTTP_1_1) || supportedVersions.contains(HttpVersion.HTTP_1_0) ? (co.getHttp1Config() != null ? co.getHttp1Config() : new Http1ClientConfig()) : null,
         supportedVersions.contains(HttpVersion.HTTP_2) ? (co.getHttp2Config() != null ? co.getHttp2Config() : new Http2ClientConfig()) : null,

vertx-core/src/main/java/io/vertx/core/http/impl/tcp/TcpHttpClientTransport.java

@@ -67,7 +67,7 @@ public static TcpHttpClientTransport create(NetClientInternal netClient,
     return new TcpHttpClientTransport(netClient,
       config.getTracingPolicy(),
       config.isDecompressionEnabled(),
-      config.getTcpConfig().getNetworkLogging() != null,
+      config.getTcpConfig().getNetworkLogging() != null && config.getTcpConfig().getNetworkLogging().isEnabled(),
       config.getTcpConfig().getNetworkLogging() != null ? config.getTcpConfig().getNetworkLogging().getDataFormat() : null,
       config.isForceSni(),
       config.getHttp1Config(),

vertx-core/src/main/java/io/vertx/core/net/NetworkLogging.java

@@ -23,16 +23,37 @@
 @DataObject
 public class NetworkLogging {
 
+  private boolean enabled;
   private ByteBufFormat dataFormat;
 
   public NetworkLogging() {
+    enabled = NetworkOptions.DEFAULT_LOG_ENABLED;
     dataFormat = NetworkOptions.DEFAULT_LOG_ACTIVITY_FORMAT;
   }
 
   public NetworkLogging(NetworkLogging other) {
+    enabled = other.enabled;
     dataFormat = other.dataFormat;
   }
 
+  /**
+   * @return {@code} when network logging is enabled
+   */
+  public boolean isEnabled() {
+    return enabled;
+  }
+
+  /**
+   * Set to true to enable network logging: Netty's pipeline is configured for logging on Netty's logger.
+   *
+   * @param enabled true for logging the network activity
+   * @return a reference to this, so the API can be used fluently
+   */
+  public NetworkLogging setEnabled(boolean enabled) {
+    this.enabled = enabled;
+    return this;
+  }
+
   /**
    * @return per stream Netty's logging handler's data format.
    */

vertx-core/src/main/java/io/vertx/core/net/TcpEndpointConfig.java

@@ -47,7 +47,7 @@ public TcpEndpointConfig(TCPSSLOptions options) {
     setIdleTimeout(Duration.of(options.getIdleTimeout(), options.getIdleTimeoutUnit().toChronoUnit()));
     setReadIdleTimeout(Duration.of(options.getReadIdleTimeout(), options.getIdleTimeoutUnit().toChronoUnit()));
     setWriteIdleTimeout(Duration.of(options.getWriteIdleTimeout(), options.getIdleTimeoutUnit().toChronoUnit()));
-    setNetworkLogging(options.getLogActivity() ? new NetworkLogging().setDataFormat(options.getActivityLogDataFormat()) : null);
+    setNetworkLogging(options.getLogActivity() ? new NetworkLogging().setEnabled(true).setDataFormat(options.getActivityLogDataFormat()) : null);
     setSsl(options.isSsl());
   }
 

vertx-core/src/main/java/io/vertx/core/net/impl/quic/QuicClientImpl.java

@@ -187,7 +187,8 @@ private Future<QuicConnection> connect(Channel ch,
         @Override
         protected void initChannel(Channel ch) {
           connectionGroup.add(ch);
-          ByteBufFormat activityLogging = config.getNetworkLogging() != null ? config.getNetworkLogging().getDataFormat() : null;
+          NetworkLogging networkLogging = config.getNetworkLogging();
+          ByteBufFormat activityLogging = networkLogging != null && networkLogging.isEnabled()? networkLogging.getDataFormat() : null;
           QuicConnectionHandler handler = new QuicConnectionHandler(context, metrics, config.getIdleTimeout(),
             config.getReadIdleTimeout(), config.getWriteIdleTimeout(), activityLogging, remoteAddress, promise::tryComplete);
           ch.pipeline().addLast("handler", handler);

vertx-core/src/main/java/io/vertx/core/net/impl/quic/QuicServerImpl.java

@@ -157,7 +157,8 @@ protected QuicCodecBuilder<?> codecBuilder(ContextInternal context, SslContextPr
               protected void initChannel(Channel ch) {
                 connectionGroup.add(ch);
                 QuicChannel channel = (QuicChannel) ch;
-                ByteBufFormat activityLogging = config.getNetworkLogging() != null ? config.getNetworkLogging().getDataFormat() : null;
+                NetworkLogging networkLogging = config.getNetworkLogging();
+                ByteBufFormat activityLogging = networkLogging != null && networkLogging.isEnabled() ? networkLogging.getDataFormat() : null;
                 QuicConnectionHandler handler = new QuicConnectionHandler(context, metrics, config.getIdleTimeout(),
                   config.getReadIdleTimeout(), config.getWriteIdleTimeout(), activityLogging,
                   vertx.transport().convert(channel.remoteSocketAddress()), QuicServerImpl.this.handler);

vertx-core/src/main/java/io/vertx/core/net/impl/tcp/NetClientImpl.java

@@ -80,11 +80,12 @@ protected void handleClose(Completable<Void> completion) {
         NetClientImpl.this.handleClose(completion);
       }
     };
+    NetworkLogging networkLogging = config.getNetworkLogging();
     this.config = config;
     this.registerWriteHandler = registerWriteHandler;
     this.sslContextManager = new SslContextManager(SslContextManager.resolveEngineOptions(config.getSslEngineOptions(), sslOptions != null && sslOptions.isUseAlpn()));
     this.metrics = vertx.metrics() != null ? vertx.metrics().createTcpClientMetrics(config, protocol) : null;
-    this.logging = config.getNetworkLogging() != null ? config.getNetworkLogging().getDataFormat() : null;
+    this.logging = networkLogging != null && networkLogging.isEnabled() ? networkLogging.getDataFormat() : null;
     this.idleTimeout = config.getIdleTimeout() != null ? config.getIdleTimeout() : Duration.ofMillis(0L);
     this.readIdleTimeout = config.getReadIdleTimeout() != null ? config.getReadIdleTimeout() : Duration.ofMillis(0L);
     this.writeIdleTimeout = config.getWriteIdleTimeout() != null ? config.getWriteIdleTimeout() : Duration.ofMillis(0L);

vertx-core/src/main/java/io/vertx/core/net/impl/tcp/NetServerImpl.java

@@ -275,8 +275,9 @@ private void connected(Channel ch, SslContextManager sslContextManager, SSLOptio
   }
 
   protected void initChannel(ChannelPipeline pipeline, boolean ssl) {
-    if (config.getNetworkLogging() != null) {
-      pipeline.addLast("logging", new LoggingHandler(config.getNetworkLogging().getDataFormat()));
+    NetworkLogging networkLogging = config.getNetworkLogging();
+    if (networkLogging != null && networkLogging.isEnabled()) {
+      pipeline.addLast("logging", new LoggingHandler(networkLogging.getDataFormat()));
     }
     long idleTimeout = config.getIdleTimeout() != null ? config.getIdleTimeout().toMillis() : 0L;
     long readIdleTimeout = config.getReadIdleTimeout() != null ? config.getReadIdleTimeout().toMillis() : 0L;

vertx-core/src/test/java/io/vertx/tests/net/quic/QuicServerTest.java

@@ -1006,7 +1006,7 @@ public void testServerNameIndication() throws Exception {
   public void testServerLogging() throws Exception {
     TestLoggerFactory fact = TestUtils.testLogging(() -> {
       try {
-        testConnect(new QuicServerConfig().setNetworkLogging(new NetworkLogging()), 9999);
+        testConnect(new QuicServerConfig().setNetworkLogging(new NetworkLogging().setEnabled(true)), 9999);
       } catch (Exception e) {
         fail(e);
       }