Add command line argument to configure loggers and their level

Fixes #23

Author: acogoluegnes

pom.xml

@@ -145,6 +145,13 @@
       <scope>compile</scope>
     </dependency>
 
+    <dependency>
+      <groupId>ch.qos.logback</groupId>
+      <artifactId>logback-classic</artifactId>
+      <version>${logback.version}</version>
+      <optional>true</optional>
+    </dependency>
+
     <dependency>
       <groupId>io.dropwizard.metrics</groupId>
       <artifactId>metrics-core</artifactId>
@@ -220,13 +227,6 @@
       <scope>test</scope>
     </dependency>
 
-    <dependency>
-      <groupId>ch.qos.logback</groupId>
-      <artifactId>logback-classic</artifactId>
-      <version>${logback.version}</version>
-      <scope>test</scope>
-    </dependency>
-
     <dependency>
       <groupId>com.rabbitmq</groupId>
       <artifactId>amqp-client</artifactId>

src/docs/asciidoc/performance-tool.adoc

@@ -450,6 +450,7 @@ tracking consumers would ignore the specified offset and would start where they
 (this is the purpose of offset tracking).
 
 ===== Producer Names
+
 You can use the `--producer-names` option to set the producer names pattern and therefore
 enable <<api.adoc#outbound-message-deduplication, message deduplication>> (using the default
 publishing sequence starting at 0 and incremented for each message).
@@ -464,6 +465,36 @@ java -jar stream-perf-test.jar --producer-names %s-%d
 
 The run will start one producer and will use the `stream-1` producer reference (default stream is `stream` and the number of the producer is 1.)
 
+===== Logging
+
+The performance tool binary uses Logback with an internal configuration file.
+The default log level is `warn` with a console appender.
+
+It is possible to define loggers directly from the command line, this is useful for quick debugging.
+Use the `rabbitmq.streamperftest.loggers` system property with `name=level` pairs, e.g.:
+
+----
+java -Drabbitmq.streamperftest.loggers=com.rabbitmq.stream=debug -jar stream-perf-test.jar
+----
+
+It is possible to define several loggers by separating them with commas, e.g. `-Drabbitmq.streamperftest.loggers=com.rabbitmq.stream=debug,com.rabbitmq.stream.perf=info`.
+
+It is also possible to use an environment variable:
+
+----
+export RABBITMQ_STREAM_PERF_TEST_LOGGERS=com.rabbitmq.stream=debug
+----
+
+The system property takes precedence over the environment variable.
+
+Use the environment variable with the Docker image:
+
+----
+docker run -it --rm --network host \
+    --env RABBITMQ_STREAM_PERF_TEST_LOGGERS=com.rabbitmq.stream=debug \
+    pivotalrabbitmq/stream-perf-test
+----
+
 === Building the Performance Tool
 
 To build the uber JAR:

src/main/java/com/rabbitmq/stream/perf/LogUtils.java

@@ -0,0 +1,96 @@
+// Copyright (c) 2021 VMware, Inc. or its affiliates.  All rights reserved.
+//
+// This software, the RabbitMQ Stream Java client library, is dual-licensed under the
+// Mozilla Public License 2.0 ("MPL"), and the Apache License version 2 ("ASL").
+// For the MPL, please see LICENSE-MPL-RabbitMQ. For the ASL,
+// please see LICENSE-APACHE2.
+//
+// This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND,
+// either express or implied. See the LICENSE file for specific language governing
+// rights and limitations of this software.
+//
+// If you have any questions regarding licensing, please contact us at
+// [email protected].
+package com.rabbitmq.stream.perf;
+
+import ch.qos.logback.classic.LoggerContext;
+import ch.qos.logback.classic.joran.JoranConfigurator;
+import ch.qos.logback.core.joran.spi.JoranException;
+import ch.qos.logback.core.util.StatusPrinter;
+import java.io.BufferedReader;
+import java.io.ByteArrayInputStream;
+import java.io.IOException;
+import java.io.InputStream;
+import java.io.InputStreamReader;
+import java.nio.charset.StandardCharsets;
+import java.util.HashMap;
+import java.util.Map;
+import org.slf4j.LoggerFactory;
+
+public class LogUtils {
+
+  static void configureLog() throws IOException {
+    String loggers =
+        System.getProperty("rabbitmq.streamperftest.loggers") == null
+            ? System.getenv("RABBITMQ_STREAM_PERF_TEST_LOGGERS")
+            : System.getProperty("rabbitmq.streamperftest.loggers");
+    LoggerContext context = (LoggerContext) LoggerFactory.getILoggerFactory();
+    InputStream configurationFile = StreamPerfTest.class.getResourceAsStream("/logback.xml");
+    try {
+      String configuration =
+          processConfigurationFile(configurationFile, convertKeyValuePairs(loggers));
+      JoranConfigurator configurator = new JoranConfigurator();
+      configurator.setContext(context);
+      context.reset();
+      configurator.doConfigure(
+          new ByteArrayInputStream(configuration.getBytes(StandardCharsets.UTF_8)));
+    } catch (JoranException je) {
+      // StatusPrinter will handle this
+    } finally {
+      configurationFile.close();
+    }
+    StatusPrinter.printInCaseOfErrorsOrWarnings(context);
+  }
+
+  private static Map<String, Object> convertKeyValuePairs(String arg) {
+    if (arg == null || arg.trim().isEmpty()) {
+      return null;
+    }
+    Map<String, Object> properties = new HashMap<>();
+    for (String entry : arg.split(",")) {
+      String[] keyValue = entry.split("=");
+      try {
+        properties.put(keyValue[0], Long.parseLong(keyValue[1]));
+      } catch (NumberFormatException e) {
+        properties.put(keyValue[0], keyValue[1]);
+      }
+    }
+    return properties;
+  }
+
+  static String processConfigurationFile(InputStream configurationFile, Map<String, Object> loggers)
+      throws IOException {
+    StringBuilder loggersConfiguration = new StringBuilder();
+    if (loggers != null) {
+      for (Map.Entry<String, Object> logger : loggers.entrySet()) {
+        loggersConfiguration.append(
+            String.format(
+                "\t<logger name=\"%s\" level=\"%s\" />%s",
+                logger.getKey(),
+                logger.getValue().toString(),
+                System.getProperty("line.separator")));
+      }
+    }
+
+    BufferedReader in = new BufferedReader(new InputStreamReader(configurationFile));
+    final int bufferSize = 1024;
+    final char[] buffer = new char[bufferSize];
+    StringBuilder builder = new StringBuilder();
+    int charsRead;
+    while ((charsRead = in.read(buffer, 0, buffer.length)) > 0) {
+      builder.append(buffer, 0, charsRead);
+    }
+
+    return builder.toString().replace("${loggers}", loggersConfiguration);
+  }
+}

src/main/java/com/rabbitmq/stream/perf/StreamPerfTest.java

@@ -50,6 +50,7 @@
 import io.netty.handler.ssl.SslContextBuilder;
 import io.netty.handler.ssl.SslHandler;
 import io.netty.util.internal.PlatformDependent;
+import java.io.IOException;
 import java.io.PrintStream;
 import java.io.PrintWriter;
 import java.net.URI;
@@ -340,7 +341,8 @@ public StreamPerfTest(String[] arguments, PrintStream consoleOut, PrintStream co
     this.err = new PrintWriter(consoleErr, true);
   }
 
-  public static void main(String[] args) {
+  public static void main(String[] args) throws IOException {
+    LogUtils.configureLog();
     int exitCode = run(args, System.out, System.err);
     System.exit(exitCode);
   }

src/performance-tool/resources/logback.xml

@@ -4,7 +4,9 @@
             <pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern>
         </encoder>
     </appender>
-    
+
+    ${loggers}
+
     <root level="warn">
         <appender-ref ref="STDOUT" />
     </root>

src/test/java/com/rabbitmq/stream/perf/LogUtilsTest.java

@@ -0,0 +1,95 @@
+// Copyright (c) 2021 VMware, Inc. or its affiliates.  All rights reserved.
+//
+// This software, the RabbitMQ Stream Java client library, is dual-licensed under the
+// Mozilla Public License 2.0 ("MPL"), and the Apache License version 2 ("ASL").
+// For the MPL, please see LICENSE-MPL-RabbitMQ. For the ASL,
+// please see LICENSE-APACHE2.
+//
+// This software is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND,
+// either express or implied. See the LICENSE file for specific language governing
+// rights and limitations of this software.
+//
+// If you have any questions regarding licensing, please contact us at
+// [email protected].
+package com.rabbitmq.stream.perf;
+
+import static org.assertj.core.api.Assertions.assertThat;
+
+import java.io.ByteArrayInputStream;
+import java.io.IOException;
+import java.io.InputStream;
+import java.nio.charset.StandardCharsets;
+import java.util.Collections;
+import java.util.HashMap;
+import java.util.Map;
+import javax.xml.parsers.DocumentBuilder;
+import javax.xml.parsers.DocumentBuilderFactory;
+import org.assertj.core.api.Condition;
+import org.junit.jupiter.api.Test;
+
+public class LogUtilsTest {
+
+  static final String XML =
+      "<configuration>\n"
+          + "    <appender name=\"STDOUT\" class=\"ch.qos.logback.core.ConsoleAppender\">\n"
+          + "        <encoder>\n"
+          + "            <pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern>\n"
+          + "        </encoder>\n"
+          + "    </appender>\n"
+          + "\n"
+          + "${loggers}\n"
+          + "\n"
+          + "    <root level=\"warn\">\n"
+          + "        <appender-ref ref=\"STDOUT\" />\n"
+          + "    </root>\n"
+          + "</configuration>";
+
+  static InputStream xml() {
+    return new ByteArrayInputStream(XML.getBytes(StandardCharsets.UTF_8));
+  }
+
+  private static Condition<String> validXml() {
+    return new Condition<>(
+        xml -> {
+          try {
+            DocumentBuilderFactory factory = DocumentBuilderFactory.newInstance();
+            DocumentBuilder builder = factory.newDocumentBuilder();
+            builder.parse(new ByteArrayInputStream(xml.getBytes(StandardCharsets.UTF_8)));
+            return true;
+          } catch (Exception e) {
+            return false;
+          }
+        },
+        "Not a valid XML document");
+  }
+
+  @Test
+  void processConfigurationFileNoLoggers() throws Exception {
+    assertThat(LogUtils.processConfigurationFile(xml(), null))
+        .isEqualTo(XML.replace("${loggers}", ""))
+        .is(validXml());
+    assertThat(LogUtils.processConfigurationFile(xml(), new HashMap<>()))
+        .isEqualTo(XML.replace("${loggers}", ""))
+        .is(validXml());
+  }
+
+  @Test
+  void processConfigurationFileOneLogger() throws IOException {
+    assertThat(
+            LogUtils.processConfigurationFile(
+                xml(), Collections.singletonMap("com.rabbitmq.stream", "info")))
+        .contains("<logger name=\"com.rabbitmq.stream\" level=\"info\"")
+        .is(validXml());
+  }
+
+  @Test
+  void processConfigurationFileSeveralLoggers() throws IOException {
+    Map<String, Object> loggers = new HashMap<>();
+    loggers.put("com.rabbitmq.stream", "debug");
+    loggers.put("com.rabbitmq.stream.perf", "info");
+    assertThat(LogUtils.processConfigurationFile(xml(), loggers))
+        .contains("<logger name=\"com.rabbitmq.stream\" level=\"debug\"")
+        .contains("<logger name=\"com.rabbitmq.stream.perf\" level=\"info\"")
+        .is(validXml());
+  }
+}