updates integration tests and benchmarks to use log4j (#224)

Similar to Brave, we don't want a large amount of clutter. To reduce a
lot of it, I moved anything that uses MockWebServer to an IT (because it
spams logs). I didn't move normal tests to log4j because we have a log
capturing test that would fail. If someone wants to take a pass later at
that, they could.

Signed-off-by: Adrian Cole <adrian@tetrate.io>

activemq-client/pom.xml

@@ -30,6 +30,9 @@
     <module.name>zipkin2.reporter.activemq</module.name>
 
     <main.basedir>${project.basedir}/..</main.basedir>
+    <!-- Be conscious about a 6.x upgrade: 5.x and 6.x types are incompatible
+         as the former uses javax.jms and latter jakarta.jms. It could be
+         better to make an activemq-client6 module. -->
     <activemq.version>5.18.3</activemq.version>
 
     <!-- CI should run the "release" profile during tests to ensure no 1.8

activemq-client/src/test/resources/log4j2.properties

@@ -0,0 +1,8 @@
+appenders=console
+appender.console.type=Console
+appender.console.name=STDOUT
+appender.console.layout.type=PatternLayout
+appender.console.layout.pattern=%d{ABSOLUTE} %-5p [%t] %C{2} (%F:%L) - %m%n
+rootLogger.level=warn
+rootLogger.appenderRefs=stdout
+rootLogger.appenderRef.stdout.ref=STDOUT

amqp-client/src/test/resources/log4j2.properties

@@ -0,0 +1,8 @@
+appenders=console
+appender.console.type=Console
+appender.console.name=STDOUT
+appender.console.layout.type=PatternLayout
+appender.console.layout.pattern=%d{ABSOLUTE} %-5p [%t] %C{2} (%F:%L) - %m%n
+rootLogger.level=warn
+rootLogger.appenderRefs=stdout
+rootLogger.appenderRef.stdout.ref=STDOUT

benchmarks/pom.xml

@@ -120,10 +120,30 @@
        https://github.com/charithe/kafka-junit -->
       <version>4.2.10</version>
     </dependency>
+
+    <!-- Main code uses jul and tests log with log4j -->
+    <dependency>
+      <groupId>org.apache.logging.log4j</groupId>
+      <artifactId>log4j-core</artifactId>
+      <version>${log4j.version}</version>
+    </dependency>
+    <!-- route jul over log4j2 during integration tests -->
+    <dependency>
+      <groupId>org.apache.logging.log4j</groupId>
+      <artifactId>log4j-jul</artifactId>
+      <version>${log4j.version}</version>
+    </dependency>
+    <!-- route log4j over log4j2 during integration tests -->
+    <dependency>
+      <groupId>org.apache.logging.log4j</groupId>
+      <artifactId>log4j-1.2-api</artifactId>
+      <version>${log4j.version}</version>
+    </dependency>
+    <!-- route slf4j over log4j2 during integration tests -->
     <dependency>
-      <groupId>ch.qos.logback</groupId>
-      <artifactId>logback-classic</artifactId>
-      <version>${logback.version}</version>
+      <groupId>org.apache.logging.log4j</groupId>
+      <artifactId>log4j-slf4j-impl</artifactId>
+      <version>${log4j.version}</version>
     </dependency>
   </dependencies>
 

benchmarks/src/main/java/zipkin2/reporter/SenderBenchmarks.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2016-2019 The OpenZipkin Authors
+ * Copyright 2016-2023 The OpenZipkin Authors
  *
  * 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
@@ -34,7 +34,8 @@
 import org.openjdk.jmh.annotations.Warmup;
 import zipkin2.CheckResult;
 import zipkin2.Span;
-import zipkin2.codec.SpanBytesDecoder;
+import zipkin2.TestObjects;
+import zipkin2.codec.SpanBytesEncoder;
 
 /**
  * This benchmark reports spans as fast as possible. The sender clears the queue as fast as
@@ -59,15 +60,18 @@ public abstract class SenderBenchmarks {
 
   public int messageMaxBytes;
 
-  static final byte[] clientSpanBytes = spanFromResource("/zipkin2-client.json");
-  static final Span clientSpan = SpanBytesDecoder.JSON_V2.decodeOne(clientSpanBytes);
-
+  static final Span clientSpan = TestObjects.CLIENT_SPAN;
+  static final byte[] clientSpanBytes = SpanBytesEncoder.JSON_V2.encode(clientSpan);
   static final InMemoryReporterMetrics metrics = new InMemoryReporterMetrics();
 
   @AuxCounters
   @State(Scope.Thread)
   public static class InMemoryReporterMetricsAsCounters {
 
+    static {
+      System.setProperty("java.util.logging.manager", "org.apache.logging.log4j.jul.LogManager");
+    }
+
     public long spans() {
       return metrics.spans() - metrics.spansDropped();
     }

benchmarks/src/main/resources/log4j2.properties

@@ -0,0 +1,15 @@
+appenders=console
+appender.console.type=Console
+appender.console.name=STDOUT
+appender.console.layout.type=PatternLayout
+appender.console.layout.pattern=%d{ABSOLUTE} %-5p [%t] %C{2} (%F:%L) - %m%n
+rootLogger.level=warn
+rootLogger.appenderRefs=stdout
+rootLogger.appenderRef.stdout.ref=STDOUT
+# uncomment to include kafka consumer configuration in test logs
+#logger.kafka-clients.name=org.apache.kafka.clients
+#logger.kafka-clients.level=info
+logger.kafkaunit.name=com.github.charithe.kafka
+logger.kafkaunit.level=off
+logger.kafka.name=zipkin2.reporter.kafka
+logger.kafka.level=debug

kafka/src/test/resources/log4j2.properties

@@ -0,0 +1,23 @@
+appenders=console
+appender.console.type=Console
+appender.console.name=STDOUT
+appender.console.layout.type=PatternLayout
+appender.console.layout.pattern=%d{ABSOLUTE} %-5p [%t] %C{2} (%F:%L) - %m%n
+rootLogger.level=warn
+rootLogger.appenderRefs=stdout
+rootLogger.appenderRef.stdout.ref=STDOUT
+# uncomment to include kafka consumer configuration in test logs
+#logger.kafka-clients.name=org.apache.kafka.clients
+#logger.kafka-clients.level=info
+logger.kafka.name=zipkin2.reporter.kafka
+logger.kafka.level=debug
+
+# hush the unit test runner
+logger.BrokerMetadataCheckpoint.name=kafka.server.BrokerMetadataCheckpoint
+logger.BrokerMetadataCheckpoint.level=off
+
+# don't waste logs when ZK check fails
+logger.ClientCnxn.name=org.apache.zookeeper.ClientCnxn
+logger.ClientCnxn.level=off
+logger.NetworkClient.name=org.apache.kafka.clients.NetworkClient
+logger.NetworkClient.level=off

libthrift/src/test/resources/log4j2.properties

@@ -0,0 +1,8 @@
+appenders=console
+appender.console.type=Console
+appender.console.name=STDOUT
+appender.console.layout.type=PatternLayout
+appender.console.layout.pattern=%d{ABSOLUTE} %-5p [%t] %C{2} (%F:%L) - %m%n
+rootLogger.level=warn
+rootLogger.appenderRefs=stdout
+rootLogger.appenderRef.stdout.ref=STDOUT

okhttp3/pom.xml

@@ -88,6 +88,7 @@
               <artifactId>mockwebserver</artifactId>
               <version>${old-okhttp.version}</version>
               <repositoryType>MAIN</repositoryType>
+              <type>jar</type>
             </DynamicDependency>
           </dynamicDependencies>
         </configuration>

okhttp3/src/it/okhttp3_v3/pom.xml

@@ -68,26 +68,54 @@
       <artifactId>zipkin-tests</artifactId>
       <version>@zipkin.version@</version>
     </dependency>
+
+    <!-- route jul over log4j2 during integration tests -->
+    <dependency>
+      <groupId>org.apache.logging.log4j</groupId>
+      <artifactId>log4j-core</artifactId>
+      <version>@log4j.version@</version>
+    </dependency>
+    <dependency>
+      <groupId>org.apache.logging.log4j</groupId>
+      <artifactId>log4j-jul</artifactId>
+      <version>@log4j.version@</version>
+    </dependency>
   </dependencies>
 
   <build>
     <sourceDirectory>@project.build.testSourceDirectory@</sourceDirectory>
+    <testResources>
+      <testResource>
+        <directory>@project.basedir@/src/test/resources</directory>
+      </testResource>
+    </testResources>
     <plugins>
       <plugin>
         <artifactId>maven-compiler-plugin</artifactId>
         <version>@maven-compiler-plugin.version@</version>
         <configuration>
           <includes>
-            <include>**/*Test.java</include>
+            <include>**/IT*.java</include>
           </includes>
         </configuration>
       </plugin>
       <plugin>
+        <!-- Use surefire to run the ITs until someone figures out how to get invoker to run
+             failsafe -->
         <artifactId>maven-surefire-plugin</artifactId>
         <version>@maven-surefire-plugin.version@</version>
         <configuration>
-          <!-- Ensures root cause ends up in the console -->
-          <trimStackTrace>false</trimStackTrace>
+          <failIfNoTests>true</failIfNoTests>
+          <includes>
+            <include>**/IT*.java</include>
+          </includes>
+          <!-- Try to prevent flakes in CI -->
+          <reuseForks>false</reuseForks>
+          <!-- workaround to SUREFIRE-1831 -->
+          <useModulePath>false</useModulePath>
+          <systemPropertyVariables>
+            <java.util.logging.manager>org.apache.logging.log4j.jul.LogManager</java.util.logging.manager>
+          </systemPropertyVariables>
         </configuration>
       </plugin>
     </plugins>