results

hendrikebbers · hendrikebbers · commit eda256999895 · 2023-08-15T19:31:47.000+02:00
diff --git a/README.md b/README.md
@@ -1,2 +1,52 @@
-# java-logger-benchmar
-A benchmark for several different Java loggers
+# Java Logger Benchmark
+
+This project is a benchmark for several Java logging libraries. It is using JMH to measure the performance of the
+different logging libraries.
+
+## What libraries are tested?
+
+Currently, the following libraries are tested:
+
+- Java Util Logging
+- Log4j 2
+- Log4j 2 with Async Logger
+- SLF4J Simple
+- Chronicle Logger
+
+## How to run the benchmark?
+
+The project is based on Maven and the Maven wrapper is included. To run the benchmark, simply execute the following
+command:
+
+```
+./mvnw clean test
+```
+
+The JMH benchmark is executed by several parameters that are all defined in the
+`com.openelements.logger.api.BenchmarkConstants` class in the `logger-api` module.
+
+## How to add a new logging library?
+
+To add a new logging library, you need to create a new module that contains the implementation of the logging library.
+The `logger-api` module contains a simple interface that needs to be implemented by the logging library. By doing so a
+benchmark for the new logging library can be created that executes the `LogLikeHell` Runnable. All logging libraries
+execute that code to generate comparable results.
+
+## What are the results?
+
+I still need to run the code in a long running benchmark. For a short running benchmark the values look like that (
+sorted from fastest to slowest):
+
+| Logger            | Logging Appender       | Operations per second |
+|-------------------|------------------------|----------------------:|
+| Log4J2            | FILE_ASYNC             |             26443,286 |
+| Chronicle Logger  | FILE_ASYNC             |             23435,042 |
+| Log4J2            | FILE                   |             13262,229 |
+| Java Util Logging | FILE                   |              5793,153 |
+| Log4J2            | FILE_ASYNC_AND_CONSOLE |              3853,433 |
+| Log4J2            | FILE_AND_CONSOLE       |              3686,111 |
+| Log4J2            | CONSOLE                |              3720,956 |
+| Java Util Logging | CONSOLE                |              3430,061 |
+| Java Util Logging | FILE_AND_CONSOLE       |              2712,309 |
+
+
diff --git a/chronicle-logger/src/main/java/com/openelements/logger/chronicle/ChronicleLogger.java b/chronicle-logger/src/main/java/com/openelements/logger/chronicle/ChronicleLogger.java
@@ -3,7 +3,6 @@
 import com.openelements.logger.api.Logger;
 import java.util.HashMap;
 import java.util.Map;
-import java.util.stream.IntStream;
 import net.openhft.chronicle.logger.ChronicleLogLevel;
 import net.openhft.chronicle.logger.ChronicleLogManager;
 import net.openhft.chronicle.logger.ChronicleLogWriter;
@@ -71,12 +70,4 @@ public Logger withMarker(String marker) {
         }
         return this;
     }
-
-    @Override
-    public String createMessageWithPlaceholders(int placeholderCount) {
-        return IntStream.range(0, placeholderCount)
-                .mapToObj(i -> "{},")
-                .reduce((a, b) -> a + " " + b)
-                .orElse("");
-    }
 }
diff --git a/jmh-benchmarks/src/test/java/com/openelements/logger/benchmarks/ChronicleLoggerBenchmark.java b/jmh-benchmarks/src/test/java/com/openelements/logger/benchmarks/ChronicleLoggerBenchmark.java
@@ -1,11 +1,12 @@
 package com.openelements.logger.benchmarks;
 
-import static com.openelements.logger.benchmarks.BenchmarkConstants.MEASUREMENT_ITERATIONS;
-import static com.openelements.logger.benchmarks.BenchmarkConstants.MEASUREMENT_TIME_IN_SECONDS_PER_ITERATION;
-import static com.openelements.logger.benchmarks.BenchmarkConstants.PARALLEL_THREAD_COUNT;
-import static com.openelements.logger.benchmarks.BenchmarkConstants.WARMUP_ITERATIONS;
-import static com.openelements.logger.benchmarks.BenchmarkConstants.WARMUP_TIME_IN_SECONDS_PER_ITERATION;
+import static com.openelements.logger.api.BenchmarkConstants.MEASUREMENT_ITERATIONS;
+import static com.openelements.logger.api.BenchmarkConstants.MEASUREMENT_TIME_IN_SECONDS_PER_ITERATION;
+import static com.openelements.logger.api.BenchmarkConstants.PARALLEL_THREAD_COUNT;
+import static com.openelements.logger.api.BenchmarkConstants.WARMUP_ITERATIONS;
+import static com.openelements.logger.api.BenchmarkConstants.WARMUP_TIME_IN_SECONDS_PER_ITERATION;
 
+import com.openelements.logger.api.LogLikeHell;
 import com.openelements.logger.api.Logger;
 import com.openelements.logger.chronicle.ChronicleLogger;
 import java.nio.file.Files;
diff --git a/jmh-benchmarks/src/test/java/com/openelements/logger/benchmarks/JulLoggerBenchmark.java b/jmh-benchmarks/src/test/java/com/openelements/logger/benchmarks/JulLoggerBenchmark.java
@@ -1,11 +1,12 @@
 package com.openelements.logger.benchmarks;
 
-import static com.openelements.logger.benchmarks.BenchmarkConstants.MEASUREMENT_ITERATIONS;
-import static com.openelements.logger.benchmarks.BenchmarkConstants.MEASUREMENT_TIME_IN_SECONDS_PER_ITERATION;
-import static com.openelements.logger.benchmarks.BenchmarkConstants.PARALLEL_THREAD_COUNT;
-import static com.openelements.logger.benchmarks.BenchmarkConstants.WARMUP_ITERATIONS;
-import static com.openelements.logger.benchmarks.BenchmarkConstants.WARMUP_TIME_IN_SECONDS_PER_ITERATION;
+import static com.openelements.logger.api.BenchmarkConstants.MEASUREMENT_ITERATIONS;
+import static com.openelements.logger.api.BenchmarkConstants.MEASUREMENT_TIME_IN_SECONDS_PER_ITERATION;
+import static com.openelements.logger.api.BenchmarkConstants.PARALLEL_THREAD_COUNT;
+import static com.openelements.logger.api.BenchmarkConstants.WARMUP_ITERATIONS;
+import static com.openelements.logger.api.BenchmarkConstants.WARMUP_TIME_IN_SECONDS_PER_ITERATION;
 
+import com.openelements.logger.api.LogLikeHell;
 import com.openelements.logger.api.Logger;
 import com.openelements.logger.jul.JulLogger;
 import java.io.InputStream;
diff --git a/jmh-benchmarks/src/test/java/com/openelements/logger/benchmarks/Log4JLoggerBenchmark.java b/jmh-benchmarks/src/test/java/com/openelements/logger/benchmarks/Log4JLoggerBenchmark.java
@@ -1,11 +1,12 @@
 package com.openelements.logger.benchmarks;
 
-import static com.openelements.logger.benchmarks.BenchmarkConstants.MEASUREMENT_ITERATIONS;
-import static com.openelements.logger.benchmarks.BenchmarkConstants.MEASUREMENT_TIME_IN_SECONDS_PER_ITERATION;
-import static com.openelements.logger.benchmarks.BenchmarkConstants.PARALLEL_THREAD_COUNT;
-import static com.openelements.logger.benchmarks.BenchmarkConstants.WARMUP_ITERATIONS;
-import static com.openelements.logger.benchmarks.BenchmarkConstants.WARMUP_TIME_IN_SECONDS_PER_ITERATION;
+import static com.openelements.logger.api.BenchmarkConstants.MEASUREMENT_ITERATIONS;
+import static com.openelements.logger.api.BenchmarkConstants.MEASUREMENT_TIME_IN_SECONDS_PER_ITERATION;
+import static com.openelements.logger.api.BenchmarkConstants.PARALLEL_THREAD_COUNT;
+import static com.openelements.logger.api.BenchmarkConstants.WARMUP_ITERATIONS;
+import static com.openelements.logger.api.BenchmarkConstants.WARMUP_TIME_IN_SECONDS_PER_ITERATION;
 
+import com.openelements.logger.api.LogLikeHell;
 import com.openelements.logger.api.Logger;
 import com.openelements.logger.log4j.Log4JLogger;
 import java.nio.file.Files;
diff --git a/jul-logger/src/main/java/com/openelements/logger/jul/JulLogger.java b/jul-logger/src/main/java/com/openelements/logger/jul/JulLogger.java
@@ -4,7 +4,6 @@
 import java.util.HashMap;
 import java.util.Map;
 import java.util.logging.Level;
-import java.util.stream.IntStream;
 import org.slf4j.helpers.MessageFormatter;
 
 public class JulLogger implements com.openelements.logger.api.Logger {
@@ -50,14 +49,6 @@ public void log(String message, Throwable throwable, Object... args) {
         metadata.clear();
     }
 
-    @Override
-    public String createMessageWithPlaceholders(int placeholderCount) {
-        return IntStream.range(0, placeholderCount)
-                .mapToObj(i -> "{},")
-                .reduce((a, b) -> a + " " + b)
-                .orElse("");
-    }
-
     @Override
     public Logger withMetadata(String key, Object value) {
         metadata.put(key, value.toString());
diff --git a/log4j2-logger/src/main/java/com/openelements/logger/log4j/Log4JLogger.java b/log4j2-logger/src/main/java/com/openelements/logger/log4j/Log4JLogger.java
@@ -1,8 +1,6 @@
 package com.openelements.logger.log4j;
 
 import com.openelements.logger.api.Logger;
-import java.util.stream.Collectors;
-import java.util.stream.IntStream;
 import org.apache.logging.log4j.Level;
 import org.apache.logging.log4j.Marker;
 import org.apache.logging.log4j.MarkerManager;
@@ -79,11 +77,4 @@ public Logger withMarker(String marker) {
         }
         return this;
     }
-
-    @Override
-    public String createMessageWithPlaceholders(int placeholderCount) {
-        return IntStream.range(0, placeholderCount)
-                .mapToObj(i -> "{},")
-                .collect(Collectors.joining(" "));
-    }
 }
diff --git a/logger-api/src/main/java/com/openelements/logger/api/BenchmarkConstants.java b/logger-api/src/main/java/com/openelements/logger/api/BenchmarkConstants.java
@@ -1,14 +1,14 @@
-package com.openelements.logger.benchmarks;
+package com.openelements.logger.api;
 
 public class BenchmarkConstants {
 
-    public final static int WARMUP_ITERATIONS = 10;
+    public final static int WARMUP_ITERATIONS = 2;
 
-    public final static int WARMUP_TIME_IN_SECONDS_PER_ITERATION = 4;
+    public final static int WARMUP_TIME_IN_SECONDS_PER_ITERATION = 2;
 
-    public final static int MEASUREMENT_ITERATIONS = 10;
+    public final static int MEASUREMENT_ITERATIONS = 2;
 
-    public final static int MEASUREMENT_TIME_IN_SECONDS_PER_ITERATION = 4;
+    public final static int MEASUREMENT_TIME_IN_SECONDS_PER_ITERATION = 2;
 
     public final static int PARALLEL_THREAD_COUNT = 4;
 
diff --git a/logger-api/src/main/java/com/openelements/logger/api/LogLikeHell.java b/logger-api/src/main/java/com/openelements/logger/api/LogLikeHell.java
@@ -1,6 +1,5 @@
-package com.openelements.logger.benchmarks;
+package com.openelements.logger.api;
 
-import com.openelements.logger.api.Logger;
 import java.util.UUID;
 
 public class LogLikeHell implements Runnable {
@@ -13,22 +12,23 @@ public LogLikeHell(Logger logger) {
 
     @Override
     public void run() {
-        String messageWithPlaceholder = "Hello " + logger.createMessageWithPlaceholders(1) + "!";
-        String messageWith9Placeholder = "Hello " + logger.createMessageWithPlaceholders(9) + "!";
+        String messageWithPlaceholder = "Hello {}!";
+        String messageWith9Placeholder = "Hello {}, {}, {}, {}, {}, {}, {}, {}, {}!";
 
         logger.log("L1, Hello world!");
         logger.log("L2, Hello world!", new RuntimeException("Oh no!"));
-        logger.log("L3, " + messageWithPlaceholder, "placeholder");
-        logger.log("L4, " + messageWithPlaceholder, new RuntimeException("Oh no!"), "placeholder");
+        logger.log("L3, Hello {}!", "placeholder");
+        logger.log("L4, Hello {}!", new RuntimeException("Oh no!"), "placeholder");
 
         logger.withMetadata("key", "value").log("L5, Hello world!");
         logger.withMarker("marker").log("L6, Hello world!");
 
         final String id = UUID.randomUUID().toString();
         logger.withMetadata("id", id).log("L7, Hello world!");
-        logger.withMetadata("id", id).log("L8, " + messageWith9Placeholder, 1, 2, 3, 4, 5, 6, 7, 8, 9);
+        logger.withMetadata("id", id).log("L8, Hello {}, {}, {}, {}, {}, {}, {}, {}, {}!", 1, 2, 3, 4, 5, 6, 7, 8, 9);
         logger.withMetadata("id", id)
-                .log("L9, " + messageWith9Placeholder, new RuntimeException("Oh no!"), 1, 2, 3, 4, 5, 6, 7,
+                .log("L9, Hello {}, {}, {}, {}, {}, {}, {}, {}, {}!", new RuntimeException("Oh no!"), 1, 2, 3, 4, 5, 6,
+                        7,
                         8, 9);
 
         logger.withMetadata("id", id)
diff --git a/logger-api/src/main/java/com/openelements/logger/api/Logger.java b/logger-api/src/main/java/com/openelements/logger/api/Logger.java
@@ -14,6 +14,4 @@ public interface Logger {
 
     Logger withMarker(String marker);
 
-    String createMessageWithPlaceholders(int placeholderCount);
-
 }
diff --git a/pom.xml b/pom.xml
@@ -20,6 +20,7 @@
     <module>jul-logger</module>
     <module>chronicle-logger</module>
     <module>log4j2-logger</module>
+    <module>slf4j-simple-logger</module>
     <module>jmh-benchmarks</module>
   </modules>
 
diff --git a/slf4j-simple-logger/pom.xml b/slf4j-simple-logger/pom.xml
@@ -0,0 +1,67 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project xmlns="http://maven.apache.org/POM/4.0.0"
+  xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+  xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+  <modelVersion>4.0.0</modelVersion>
+
+  <parent>
+    <groupId>com.open-elements.logging</groupId>
+    <artifactId>java-logger-benchmark</artifactId>
+    <version>1.0-SNAPSHOT</version>
+  </parent>
+
+  <artifactId>slf4j-simple-logger</artifactId>
+  <version>1.0-SNAPSHOT</version>
+
+  <dependencies>
+    <dependency>
+      <groupId>${groupId}</groupId>
+      <artifactId>logger-api</artifactId>
+      <version>${version}</version>
+    </dependency>
+    <dependency>
+      <groupId>org.slf4j</groupId>
+      <artifactId>slf4j-api</artifactId>
+      <version>1.7.30</version>
+    </dependency>
+    <dependency>
+      <groupId>org.slf4j</groupId>
+      <artifactId>slf4j-simple</artifactId>
+      <version>1.7.30</version>
+      <scope>test</scope>
+    </dependency>
+    <dependency>
+      <groupId>org.openjdk.jmh</groupId>
+      <artifactId>jmh-core</artifactId>
+      <version>1.37</version>
+      <scope>test</scope>
+    </dependency>
+  </dependencies>
+
+  <build>
+    <plugins>
+      <plugin>
+        <groupId>pw.krejci</groupId>
+        <artifactId>jmh-maven-plugin</artifactId>
+        <version>0.2.2</version>
+        <executions>
+          <execution>
+            <id>run-benchmarks</id>
+            <goals>
+              <goal>benchmark</goal>
+            </goals>
+            <phase>test</phase>
+            <configuration>
+              <jvmArgsAppend>
+                <arg>--add-opens java.base/java.lang.reflect=ALL-UNNAMED --add-opens java.base/sun.nio.ch=ALL-UNNAMED
+                  --illegal-access=permit --add-exports java.base/jdk.internal.ref=ALL-UNNAMED
+                </arg>
+              </jvmArgsAppend>
+            </configuration>
+          </execution>
+        </executions>
+      </plugin>
+    </plugins>
+  </build>
+
+</project>
diff --git a/slf4j-simple-logger/src/main/java/com/openelements/logger/slf4j/Slf4jLogger.java b/slf4j-simple-logger/src/main/java/com/openelements/logger/slf4j/Slf4jLogger.java
@@ -0,0 +1,78 @@
+package com.openelements.logger.slf4j;
+
+import com.openelements.logger.api.Logger;
+import org.slf4j.MDC;
+import org.slf4j.Marker;
+import org.slf4j.helpers.MessageFormatter;
+
+public class Slf4jLogger implements Logger {
+
+    private final org.slf4j.Logger logger;
+
+    private Marker marker;
+
+    public Slf4jLogger(Class cls) {
+        logger = org.slf4j.LoggerFactory.getLogger(cls);
+    }
+
+    @Override
+    public void log(String message) {
+        if (marker != null) {
+            logger.info(marker, message);
+        } else {
+            logger.info(message);
+        }
+        marker = null;
+        MDC.clear();
+    }
+
+    @Override
+    public void log(String message, Throwable throwable) {
+        if (marker != null) {
+            logger.info(marker, message, throwable);
+        } else {
+            logger.info(message, throwable);
+        }
+        marker = null;
+        MDC.clear();
+    }
+
+    @Override
+    public void log(String message, Object... args) {
+        if (marker != null) {
+            logger.info(marker, message, args);
+        } else {
+            logger.info(message, args);
+        }
+        marker = null;
+        MDC.clear();
+    }
+
+    @Override
+    public void log(String message, Throwable throwable, Object... args) {
+        if (marker != null) {
+            logger.info(marker, MessageFormatter.arrayFormat(message, args).getMessage(), throwable);
+        } else {
+            logger.info(MessageFormatter.arrayFormat(message, args).getMessage(), throwable);
+        }
+        marker = null;
+        MDC.clear();
+    }
+
+    @Override
+    public Logger withMetadata(String key, Object value) {
+        MDC.put(key, value.toString());
+        return this;
+    }
+
+    @Override
+    public Logger withMarker(String marker) {
+        if (this.marker == null) {
+            this.marker = org.slf4j.MarkerFactory.getMarker(marker);
+        } else {
+            this.marker.add(org.slf4j.MarkerFactory.getMarker(marker));
+        }
+        return this;
+    }
+
+}
diff --git a/slf4j-simple-logger/src/main/java/module-info.java b/slf4j-simple-logger/src/main/java/module-info.java
diff --git a/slf4j-simple-logger/src/test/java/com/openelements/logger/slf4j/Slf4JSimpleBenchmark.java b/slf4j-simple-logger/src/test/java/com/openelements/logger/slf4j/Slf4JSimpleBenchmark.java
diff --git a/slf4j-simple-logger/src/test/resources/simplelogger.properties b/slf4j-simple-logger/src/test/resources/simplelogger.properties

Original file line number	Diff line number	Diff line change
`@@ -1,8 +1,6 @@`
`1`	`1`	`package com.openelements.logger.log4j;`
`2`	`2`
`3`	`3`	`import com.openelements.logger.api.Logger;`
`4`		`-import java.util.stream.Collectors;`
`5`		`-import java.util.stream.IntStream;`
`6`	`4`	`import org.apache.logging.log4j.Level;`
`7`	`5`	`import org.apache.logging.log4j.Marker;`
`8`	`6`	`import org.apache.logging.log4j.MarkerManager;`
`@@ -79,11 +77,4 @@ public Logger withMarker(String marker) {`
`79`	`77`	`}`
`80`	`78`	`return this;`
`81`	`79`	`}`
`82`		`-`
`83`		`- @Override`
`84`		`- public String createMessageWithPlaceholders(int placeholderCount) {`
`85`		`- return IntStream.range(0, placeholderCount)`
`86`		`- .mapToObj(i -> "{},")`
`87`		`- .collect(Collectors.joining(" "));`
`88`		`- }`
`89`	`80`	`}`
Original file line number	Diff line number	Diff line change
`@@ -14,6 +14,4 @@ public interface Logger {`
`14`	`14`
`15`	`15`	`Logger withMarker(String marker);`
`16`	`16`
`17`		`- String createMessageWithPlaceholders(int placeholderCount);`
`18`		`-`
`19`	`17`	`}`