Improve `log4j-perf-test` instructions
diff --git a/log4j-perf-test/README.adoc b/log4j-perf-test/README.adoc
index ab79510..ccf365f 100644
--- a/log4j-perf-test/README.adoc
+++ b/log4j-perf-test/README.adoc
@@ -20,11 +20,38 @@
[source,bash]
----
-java -jar target/log4j-perf-test-*-uber.jar <JMH-ARGS>
+java -cp target/log4j-perf-test-*-uber.jar org.openjdk.jmh.Main <JMH-ARGS>
----
To list the available JMH arguments run:
[source,bash]
----
-java -jar target/log4j-perf-test-*-uber.jar -h
+java -cp target/log4j-perf-test-*-uber.jar org.openjdk.jmh.Main -h
+----
+
+== Examples
+
+`ThreadLocalVsPoolBenchmark`::
++
+[source,bash]
+----
+java -cp target/log4j-perf-test-*-uber.jar org.openjdk.jmh.Main \
+ -f 1 -wi 10 -i 20 \
+ -tu ns -bm sample \
+ ".*ThreadLocalVsPoolBenchmark.*"
+----
+
+`JsonTemplateLayoutBenchmark`::
++
+[source,bash]
+----
+java -cp target/log4j-perf-test-*-uber.jar org.openjdk.jmh.Main \
+ -f 2 \
+ -wi 3 -w 20s \
+ -i 5 -r 30s \
+ -prof gc \
+ -prof perfnorm \
+ -prof "async:libPath=/path/to/libasyncProfiler.so;output=flamegraph" \
+ -rf json -rff log4j-perf-test/target/JsonTemplateLayoutBenchmarkResult.json \
+ ".*JsonTemplateLayoutBenchmark.*"
----
diff --git a/log4j-perf-test/src/main/java/org/apache/logging/log4j/layout/template/json/JsonTemplateLayoutBenchmark.java b/log4j-perf-test/src/main/java/org/apache/logging/log4j/layout/template/json/JsonTemplateLayoutBenchmark.java
index 6bfa1a0..aa4a186 100644
--- a/log4j-perf-test/src/main/java/org/apache/logging/log4j/layout/template/json/JsonTemplateLayoutBenchmark.java
+++ b/log4j-perf-test/src/main/java/org/apache/logging/log4j/layout/template/json/JsonTemplateLayoutBenchmark.java
@@ -29,7 +29,7 @@
* You can run this test as follows:
* <pre>{@code
* java \
- * -jar log4j-perf/target/benchmarks.jar \
+ * -cp target/log4j-perf-test-*-uber.jar org.openjdk.jmh.Main \
* -f 2 \
* -wi 3 -w 20s \
* -i 5 -r 30s \
diff --git a/log4j-perf-test/src/main/java/org/apache/logging/log4j/layout/template/json/JsonTemplateLayoutBenchmarkReport.java b/log4j-perf-test/src/main/java/org/apache/logging/log4j/layout/template/json/JsonTemplateLayoutBenchmarkReport.java
index c02d7d0..2934f55 100644
--- a/log4j-perf-test/src/main/java/org/apache/logging/log4j/layout/template/json/JsonTemplateLayoutBenchmarkReport.java
+++ b/log4j-perf-test/src/main/java/org/apache/logging/log4j/layout/template/json/JsonTemplateLayoutBenchmarkReport.java
@@ -45,7 +45,7 @@
* Usage:
* <pre>
* java \
- * -cp log4j-perf/target/benchmarks.jar \
+ * -cp target/log4j-perf-test-*-uber.jar \
* org.apache.logging.log4j.layout.template.json.JsonTemplateLayoutBenchmarkReport \
* log4j-perf/target/JsonTemplateLayoutBenchmarkResult.json \
* log4j-perf/target/JsonTemplateLayoutBenchmarkReport.adoc
diff --git a/log4j-perf-test/src/main/java/org/apache/logging/log4j/message/ParameterFormatterBenchmark.java b/log4j-perf-test/src/main/java/org/apache/logging/log4j/message/ParameterFormatterBenchmark.java
index 02dc13c..fce78e8 100644
--- a/log4j-perf-test/src/main/java/org/apache/logging/log4j/message/ParameterFormatterBenchmark.java
+++ b/log4j-perf-test/src/main/java/org/apache/logging/log4j/message/ParameterFormatterBenchmark.java
@@ -28,17 +28,6 @@
/**
* This benchmark is not in the perf.jmh package because it tests the package-protected ParameterFormatter class.
*/
-// ============================== HOW TO RUN THIS TEST: ====================================
-//
-// single thread:
-// java -jar log4j-perf/target/benchmarks.jar ".*ParameterFormatterBench.*" -f 1 -wi 5 -i 10
-//
-// multiple threads (for example, 4 threads):
-// java -jar log4j-perf/target/benchmarks.jar ".*ParameterFormatterBench.*" -f 1 -wi 5 -i 10 -t 4 -si true
-//
-// Usage help:
-// java -jar log4j-perf/target/benchmarks.jar -help
-//
@State(Scope.Benchmark)
public class ParameterFormatterBenchmark {
diff --git a/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/AbstractStringLayoutStringEncodingBenchmark.java b/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/AbstractStringLayoutStringEncodingBenchmark.java
index 4018fbe..217d21b 100644
--- a/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/AbstractStringLayoutStringEncodingBenchmark.java
+++ b/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/AbstractStringLayoutStringEncodingBenchmark.java
@@ -44,8 +44,6 @@
* Benchmarks the two different ways of encoding String to bytes in
* {@link org.apache.logging.log4j.core.layout.AbstractStringLayout} for different Charsets.
*/
-// HOW TO RUN THIS TEST
-// java -jar target/benchmarks.jar AbstractStringLayoutStringEncodingBenchmark -f 1 -i 5 -wi 5 -bm sample -tu ns
@State(Scope.Thread)
public class AbstractStringLayoutStringEncodingBenchmark {
private static final String MESSAGE =
diff --git a/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/AnnotationVsMarkerInterface.java b/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/AnnotationVsMarkerInterface.java
index e2edc10..17d700b 100644
--- a/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/AnnotationVsMarkerInterface.java
+++ b/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/AnnotationVsMarkerInterface.java
@@ -33,17 +33,6 @@
/**
* Tests performance of marker interface vs annotation.
*/
-// ============================== HOW TO RUN THIS TEST: ====================================
-//
-// single thread:
-// java -jar log4j-perf/target/benchmarks.jar ".*AnnotationVsMarkerInterface.*" -wi 5 -i 5
-//
-// multiple threads (for example, 4 threads):
-// java -jar log4j-perf/target/benchmarks.jar ".*AnnotationVsMarkerInterface.*" -wi 5 -i 5 -t 4 -si true
-//
-// Usage help:
-// java -jar log4j-perf/target/benchmarks.jar -help
-//
@OutputTimeUnit(TimeUnit.NANOSECONDS)
@Warmup(iterations = 5, time = 1, timeUnit = TimeUnit.SECONDS)
@Measurement(iterations = 10, time = 1, timeUnit = TimeUnit.SECONDS)
diff --git a/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/AsyncAppenderLog4j1Benchmark.java b/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/AsyncAppenderLog4j1Benchmark.java
index f93a136..8e3588d 100644
--- a/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/AsyncAppenderLog4j1Benchmark.java
+++ b/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/AsyncAppenderLog4j1Benchmark.java
@@ -46,17 +46,6 @@
/**
* Tests Log4j-1.2 Async Appender performance.
*/
-// ============================== HOW TO RUN THIS TEST: ====================================
-//
-// single thread:
-// java -jar log4j-perf/target/benchmarks.jar ".*AsyncAppenderLog4j1Benchmark.*" -f 1 -wi 10 -i 20
-//
-// multiple threads (for example, 4 threads):
-// java -jar log4j-perf/target/benchmarks.jar ".*AsyncAppenderLog4j1Benchmark.*" -f 1 -wi 10 -i 20 -t 4 -si true
-//
-// Usage help:
-// java -jar log4j-perf/target/benchmarks.jar -help
-//
@State(Scope.Benchmark)
public class AsyncAppenderLog4j1Benchmark {
Logger logger;
diff --git a/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/AsyncAppenderLog4j1LocationBenchmark.java b/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/AsyncAppenderLog4j1LocationBenchmark.java
index 1df9c70..c200bab 100644
--- a/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/AsyncAppenderLog4j1LocationBenchmark.java
+++ b/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/AsyncAppenderLog4j1LocationBenchmark.java
@@ -34,17 +34,6 @@
/**
* Tests Log4j-1.2 Async Appender performance when including caller location information.
*/
-// ============================== HOW TO RUN THIS TEST: ====================================
-//
-// single thread:
-// java -jar log4j-perf/target/benchmarks.jar ".*AsyncAppenderLog4j1LocationBenchmark.*" -f 1 -wi 10 -i 20
-//
-// multiple threads (for example, 4 threads):
-// java -jar log4j-perf/target/benchmarks.jar ".*AsyncAppenderLog4j1LocationBenchmark.*" -f 1 -wi 10 -i 20 -t 4 -si true
-//
-// Usage help:
-// java -jar log4j-perf/target/benchmarks.jar -help
-//
@State(Scope.Benchmark)
public class AsyncAppenderLog4j1LocationBenchmark {
Logger logger;
diff --git a/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/AsyncAppenderLog4j2Benchmark.java b/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/AsyncAppenderLog4j2Benchmark.java
index 293ff45..cb6eea7 100644
--- a/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/AsyncAppenderLog4j2Benchmark.java
+++ b/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/AsyncAppenderLog4j2Benchmark.java
@@ -52,17 +52,6 @@
/**
* Tests Log4j2 Async Appender performance.
*/
-// ============================== HOW TO RUN THIS TEST: ====================================
-//
-// single thread:
-// java -jar log4j-perf/target/benchmarks.jar ".*AsyncAppenderLog4j2Benchmark.*"
-//
-// multiple threads (for example, 4 threads):
-// java -jar log4j-perf/target/benchmarks.jar ".*AsyncAppenderLog4j2Benchmark.*" -t 4 -si true
-//
-// Usage help:
-// java -jar log4j-perf/target/benchmarks.jar -help
-//
@State(Scope.Benchmark)
@Fork(1)
@Warmup(iterations = 10)
diff --git a/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/AsyncAppenderLog4j2LocationBenchmark.java b/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/AsyncAppenderLog4j2LocationBenchmark.java
index 82d2757..6966ad5 100644
--- a/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/AsyncAppenderLog4j2LocationBenchmark.java
+++ b/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/AsyncAppenderLog4j2LocationBenchmark.java
@@ -40,17 +40,6 @@
/**
* Tests Log4j2 Async Appender performance when including caller location information.
*/
-// ============================== HOW TO RUN THIS TEST: ====================================
-//
-// single thread:
-// java -jar log4j-perf/target/benchmarks.jar ".*AsyncAppenderLog4j2LocationBenchmark.*"
-//
-// multiple threads (for example, 4 threads):
-// java -jar log4j-perf/target/benchmarks.jar ".*AsyncAppenderLog4j2LocationBenchmark.*" -t 4 -si true
-//
-// Usage help:
-// java -jar log4j-perf/target/benchmarks.jar -help
-//
@State(Scope.Benchmark)
@Fork(1)
@Warmup(iterations = 10)
diff --git a/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/AsyncAppenderLogbackBenchmark.java b/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/AsyncAppenderLogbackBenchmark.java
index b1e6b40..c2849ca 100644
--- a/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/AsyncAppenderLogbackBenchmark.java
+++ b/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/AsyncAppenderLogbackBenchmark.java
@@ -47,17 +47,6 @@
/**
* Tests Logback Async Appender performance.
*/
-// ============================== HOW TO RUN THIS TEST: ====================================
-//
-// single thread:
-// java -jar log4j-perf/target/benchmarks.jar ".*AsyncAppenderLogbackBenchmark.*" -f 1 -wi 10 -i 20
-//
-// multiple threads (for example, 4 threads):
-// java -jar log4j-perf/target/benchmarks.jar ".*AsyncAppenderLogbackBenchmark.*" -f 1 -wi 10 -i 20 -t 4 -si true
-//
-// Usage help:
-// java -jar log4j-perf/target/benchmarks.jar -help
-//
@State(Scope.Benchmark)
public class AsyncAppenderLogbackBenchmark {
diff --git a/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/AsyncAppenderLogbackLocationBenchmark.java b/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/AsyncAppenderLogbackLocationBenchmark.java
index 6574c9d..c47a388 100644
--- a/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/AsyncAppenderLogbackLocationBenchmark.java
+++ b/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/AsyncAppenderLogbackLocationBenchmark.java
@@ -35,18 +35,6 @@
/**
* Tests Logback Async Appender performance when including caller location information.
*/
-// ============================== HOW TO RUN THIS TEST: ====================================
-//
-// single thread:
-// java -jar log4j-perf/target/benchmarks.jar ".*AsyncAppenderLogbackLocationBenchmark.*" -f 1 -wi 10 -i 20
-//
-// multiple threads (for example, 4 threads):
-// java -jar log4j-perf/target/benchmarks.jar ".*AsyncAppenderLogbackLocationBenchmark.*" -f 1 -wi 10 -i 20 -t 4 -si
-// true
-//
-// Usage help:
-// java -jar log4j-perf/target/benchmarks.jar -help
-//
@State(Scope.Benchmark)
public class AsyncAppenderLogbackLocationBenchmark {
diff --git a/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/AsyncLoggersBenchmark.java b/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/AsyncLoggersBenchmark.java
index 7a1ebfa..a1fe5e4 100644
--- a/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/AsyncLoggersBenchmark.java
+++ b/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/AsyncLoggersBenchmark.java
@@ -47,17 +47,6 @@
/**
* Tests Log4j2 Async Loggers performance.
*/
-// ============================== HOW TO RUN THIS TEST: ====================================
-//
-// single thread:
-// java -jar log4j-perf/target/benchmarks.jar ".*AsyncLoggersBenchmark.*" -f 1 -wi 10 -i 20
-//
-// multiple threads (for example, 4 threads):
-// java -jar log4j-perf/target/benchmarks.jar ".*AsyncLoggersBenchmark.*" -f 1 -wi 10 -i 20 -t 4 -si true
-//
-// Usage help:
-// java -jar log4j-perf/target/benchmarks.jar -help
-//
@State(Scope.Thread)
public class AsyncLoggersBenchmark {
diff --git a/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/AsyncLoggersLocationBenchmark.java b/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/AsyncLoggersLocationBenchmark.java
index 25cf4cb..4afdcb2 100644
--- a/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/AsyncLoggersLocationBenchmark.java
+++ b/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/AsyncLoggersLocationBenchmark.java
@@ -35,17 +35,6 @@
/**
* Tests Log4j2 Async Loggers performance.
*/
-// ============================== HOW TO RUN THIS TEST: ====================================
-//
-// single thread:
-// java -jar log4j-perf/target/benchmarks.jar ".*AsyncLoggersLocationBenchmark.*" -f 1 -wi 10 -i 20
-//
-// multiple threads (for example, 4 threads):
-// java -jar log4j-perf/target/benchmarks.jar ".*AsyncLoggersLocationBenchmark.*" -f 1 -wi 10 -i 20 -t 4 -si true
-//
-// Usage help:
-// java -jar log4j-perf/target/benchmarks.jar -help
-//
@State(Scope.Thread)
public class AsyncLoggersLocationBenchmark {
diff --git a/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/ClocksBenchmark.java b/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/ClocksBenchmark.java
index 3e44659..618c56f 100644
--- a/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/ClocksBenchmark.java
+++ b/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/ClocksBenchmark.java
@@ -34,17 +34,6 @@
/**
* Tests performance of various clock implementation.
*/
-// ============================== HOW TO RUN THIS TEST: ====================================
-//
-// single thread:
-// java -jar log4j-perf/target/benchmarks.jar ".*Clocks.*" -f 1 -wi 5 -i 5
-//
-// multiple threads (for example, 4 threads):
-// java -jar log4j-perf/target/benchmarks.jar ".*Clocks.*" -f 1 -wi 5 -i 5 -t 4 -si true
-//
-// Usage help:
-// java -jar log4j-perf/target/benchmarks.jar -help
-//
@State(Scope.Thread)
public class ClocksBenchmark {
diff --git a/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/CollectionsBenchmark.java b/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/CollectionsBenchmark.java
index c002b1b..67ae937 100644
--- a/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/CollectionsBenchmark.java
+++ b/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/CollectionsBenchmark.java
@@ -25,17 +25,6 @@
import org.openjdk.jmh.annotations.State;
import org.openjdk.jmh.infra.Blackhole;
-// ============================== HOW TO RUN THIS TEST: ====================================
-//
-// In sampling mode (latency test):
-// java -jar log4j-perf/target/benchmarks.jar ".*CollectionsBenchmark.*" -i 10 -f 1 -wi 5 -bm sample -tu ns
-//
-// Multi-threading test:
-// java -jar benchmarks.jar ".*CollectionsBenchmark.*" -i 10 -f 1 -wi 5 -bm sample -tu ns -t 4
-//
-// Usage help:
-// java -jar log4j-perf/target/benchmarks.jar -help
-//
@State(Scope.Benchmark)
public class CollectionsBenchmark {
private final ConcurrentHashMap<String, Long> map1 = new ConcurrentHashMap<>();
diff --git a/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/ConfiguratorInitializeBenchmark.java b/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/ConfiguratorInitializeBenchmark.java
index 046d017..f7d39bb 100644
--- a/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/ConfiguratorInitializeBenchmark.java
+++ b/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/ConfiguratorInitializeBenchmark.java
@@ -34,8 +34,6 @@
* This benchmark demonstrates how long it takes for a simple XML configuration file to be parsed and initialize a new
* {@link org.apache.logging.log4j.core.LoggerContext} using that configuration.
*/
-// TO RUN THIS TEST:
-// java -jar target/benchmarks.jar '.*ConfiguratorInitializeBenchmark.*'
@State(Scope.Thread)
public class ConfiguratorInitializeBenchmark {
diff --git a/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/DebugDisabledBenchmark.java b/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/DebugDisabledBenchmark.java
index 280a342..fed8531 100644
--- a/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/DebugDisabledBenchmark.java
+++ b/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/DebugDisabledBenchmark.java
@@ -31,8 +31,6 @@
* all logging in production, while others disable finer logging levels in production. This benchmark demonstrates the
* overhead in calling {@code logger.isDebugEnabled()} and {@code logger.debug()}.
*/
-// HOW TO RUN THIS TEST
-// java -jar target/benchmarks.jar ".*DebugDisabledBenchmark.*" -f 1 -i 5 -wi 5 -bm sample -tu ns
@State(Scope.Thread)
public class DebugDisabledBenchmark {
Logger log4jLogger;
diff --git a/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/FileAppenderBenchmark.java b/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/FileAppenderBenchmark.java
index 71dd3ee..f77331c 100644
--- a/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/FileAppenderBenchmark.java
+++ b/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/FileAppenderBenchmark.java
@@ -36,11 +36,6 @@
* Benchmarks Log4j 2, Log4j 1, Logback and JUL using the DEBUG level which is enabled for this test. The configuration
* for each uses a FileAppender
*/
-// HOW TO RUN THIS TEST
-// java -jar log4j-perf/target/benchmarks.jar ".*FileAppenderBenchmark.*" -f 1 -wi 10 -i 20
-//
-// RUNNING THIS TEST WITH 4 THREADS:
-// java -jar log4j-perf/target/benchmarks.jar ".*FileAppenderBenchmark.*" -f 1 -wi 10 -i 20 -t 4
@State(Scope.Thread)
public class FileAppenderBenchmark {
public static final String MESSAGE = "This is a debug message";
diff --git a/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/FileAppenderParamsBenchmark.java b/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/FileAppenderParamsBenchmark.java
index 2d4bb47..07a3f85 100644
--- a/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/FileAppenderParamsBenchmark.java
+++ b/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/FileAppenderParamsBenchmark.java
@@ -38,8 +38,6 @@
* Benchmarks Log4j 2, Log4j 1, Logback and JUL using the DEBUG level which is enabled for this test. The configuration
* for each uses a FileAppender
*/
-// HOW TO RUN THIS TEST
-// java -jar target/benchmarks.jar ".*FileAppenderParamsBenchmark.*" -f 1 -i 10 -wi 20 -bm sample -tu ns
@State(Scope.Thread)
public class FileAppenderParamsBenchmark {
private FileHandler julFileHandler;
diff --git a/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/FileAppenderThrowableBenchmark.java b/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/FileAppenderThrowableBenchmark.java
index a42e6c4..8c2b0e9 100644
--- a/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/FileAppenderThrowableBenchmark.java
+++ b/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/FileAppenderThrowableBenchmark.java
@@ -47,8 +47,6 @@
* Benchmarks Log4j 2, Log4j 1, Logback and JUL using the ERROR level which is enabled for this test.
* The configuration for each writes to disk.
*/
-// HOW TO RUN THIS TEST
-// java -jar target/benchmarks.jar ".*FileAppenderThrowableBenchmark.*" -f 1 -i 10 -wi 20 -bm sample -tu ns
@State(Scope.Benchmark)
@Threads(1)
@Fork(1)
diff --git a/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/FileAppenderWithLocationBenchmark.java b/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/FileAppenderWithLocationBenchmark.java
index 0b1f72f..cad10ba 100644
--- a/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/FileAppenderWithLocationBenchmark.java
+++ b/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/FileAppenderWithLocationBenchmark.java
@@ -35,11 +35,6 @@
* Benchmarks Log4j 2, Log4j 1, Logback and JUL using the DEBUG level which is enabled for this test. The configuration
* for each uses a FileAppender
*/
-// HOW TO RUN THIS TEST
-// java -jar log4j-perf/target/benchmarks.jar ".*FileAppenderWithLocationBenchmark.*" -f 1 -wi 10 -i 20
-//
-// RUNNING THIS TEST WITH 4 THREADS:
-// java -jar log4j-perf/target/benchmarks.jar ".*FileAppenderWithLocationBenchmark.*" -f 1 -wi 10 -i 20 -t 4
@State(Scope.Thread)
public class FileAppenderWithLocationBenchmark {
public static final String MESSAGE = "This is a debug message";
diff --git a/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/FormatterLoggerBenchmark.java b/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/FormatterLoggerBenchmark.java
index 9dfc1f8..a9982a4 100644
--- a/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/FormatterLoggerBenchmark.java
+++ b/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/FormatterLoggerBenchmark.java
@@ -35,14 +35,6 @@
/**
* Tests Log4j2 Formatter Logger performance.
*/
-// ============================== HOW TO RUN THIS TEST: ====================================
-//
-// single thread:
-// java -jar log4j-perf/target/benchmarks.jar ".*FormatterLogger.*" -f 1 -wi 5 -i 5
-//
-// Usage help:
-// java -jar log4j-perf/target/benchmarks.jar -help
-//
@State(Scope.Thread)
public class FormatterLoggerBenchmark {
diff --git a/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/GelfLayoutBenchmark.java b/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/GelfLayoutBenchmark.java
index b7fde9d..74491f1 100644
--- a/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/GelfLayoutBenchmark.java
+++ b/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/GelfLayoutBenchmark.java
@@ -41,8 +41,6 @@
/**
* Benchmarks Log4j 2 GelfLayout.
*/
-// HOW TO RUN THIS TEST
-// java -jar target/benchmarks.jar GelfLayoutBenchmark -f 1 -i 5 -wi 5 -bm sample -tu ns
@State(Scope.Thread)
public class GelfLayoutBenchmark {
private static final CharSequence MESSAGE =
diff --git a/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/JdbcAppenderBenchmark.java b/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/JdbcAppenderBenchmark.java
index a5480af..83a4d45 100644
--- a/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/JdbcAppenderBenchmark.java
+++ b/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/JdbcAppenderBenchmark.java
@@ -43,13 +43,6 @@
/**
* Tests the overhead of a number of JDBC Appenders.
*/
-// ============================== HOW TO RUN THIS TEST: ====================================
-//
-// java -jar log4j-perf/target/benchmarks.jar ".*JdbcAppenderBenchmark.*" -f 1 -wi 5 -i 5
-//
-// Usage help:
-// java -jar log4j-perf/target/benchmarks.jar -help
-//
@State(Scope.Thread)
public class JdbcAppenderBenchmark {
private Logger loggerH2;
diff --git a/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/JpaAppenderBenchmark.java b/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/JpaAppenderBenchmark.java
index 378ed86..e58d761 100644
--- a/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/JpaAppenderBenchmark.java
+++ b/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/JpaAppenderBenchmark.java
@@ -43,13 +43,6 @@
/**
* Tests the overhead of a number of JPA Appenders.
*/
-// ============================== HOW TO RUN THIS TEST: ====================================
-//
-// java -jar log4j-perf/target/benchmarks.jar ".*JdbcAppenderBenchmark.*" -f 1 -wi 5 -i 5
-//
-// Usage help:
-// java -jar log4j-perf/target/benchmarks.jar -help
-//
@State(Scope.Thread)
public class JpaAppenderBenchmark {
private Logger loggerH2;
diff --git a/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/Log4j2AppenderComparisonBenchmark.java b/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/Log4j2AppenderComparisonBenchmark.java
index 07c9ae6..8f9f30c 100644
--- a/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/Log4j2AppenderComparisonBenchmark.java
+++ b/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/Log4j2AppenderComparisonBenchmark.java
@@ -41,11 +41,6 @@
/**
* Benchmarks Log4j 2's Console, File, RandomAccessFile, MemoryMappedFile and Rewrite appender.
*/
-// HOW TO RUN THIS TEST
-// java -jar log4j-perf/target/benchmarks.jar ".*Log4j2AppenderComparisonBenchmark.*" -f 1 -wi 10 -i 20
-//
-// RUNNING THIS TEST WITH 4 THREADS:
-// java -jar log4j-perf/target/benchmarks.jar ".*Log4j2AppenderComparisonBenchmark.*" -f 1 -wi 10 -i 20 -t 4
@State(Scope.Benchmark)
public class Log4j2AppenderComparisonBenchmark {
public static final String MESSAGE = "Short message";
diff --git a/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/Log4jLogEventBenchmark.java b/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/Log4jLogEventBenchmark.java
index 25ea5db..ee97bbc 100644
--- a/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/Log4jLogEventBenchmark.java
+++ b/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/Log4jLogEventBenchmark.java
@@ -114,16 +114,4 @@
return event.getSource();
}
}
-
- // ============================== HOW TO RUN THIS TEST: ====================================
- //
- // In sampling mode (latency test):
- // java -jar log4j-perf/target/benchmarks.jar ".*Log4jLogEventBenchmark.*" -i 5 -f 1 -wi 5 -bm sample -tu ns
- //
- // Throughput test:
- // java -jar benchmarks.jar ".*Log4jLogEventBenchmark.*" -i 5 -f 1 -wi 5 -bm Throughput -tu ms
- //
- // Usage help:
- // java -jar log4j-perf/target/benchmarks.jar -help
- //
}
diff --git a/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/LogBuilderMarkerFilterBenchmark.java b/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/LogBuilderMarkerFilterBenchmark.java
index fb79074..70ed02b 100644
--- a/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/LogBuilderMarkerFilterBenchmark.java
+++ b/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/LogBuilderMarkerFilterBenchmark.java
@@ -37,32 +37,11 @@
import org.openjdk.jmh.annotations.TearDown;
/**
- * <p>
* Compares {@link Logger} and {@link LogBuilder} in the presence or absence of
* a global filter. In the absence of a global filter ({@code -Dnofilter}) the
* {@link Logger} can return a no-op {@link LogBuilder} if the level is
* disabled. No such an optimization is possible in the presence of a global
* filter.
- * </p>
- * <p>
- * HOW TO RUN THIS TEST
- * </p>
- * <ul>
- * <li>single thread:
- *
- * <pre>
- * java -jar target/benchmarks.jar ".*LogBuilderMarkerFilterBenchmark.*" -p useFilter=true,false
- * </pre>
- *
- * </li>
- * <li>multiple threads (for example, 4 threads):
- *
- * <pre>
- * java -jar target/benchmarks.jar ".*LogBuilderMarkerFilterBenchmark.*" -p useFilter=true,false -t 4
- * </pre>
- *
- * </li>
- * </ul>
*/
@State(Scope.Benchmark)
@BenchmarkMode(Mode.Throughput)
diff --git a/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/LoggerConfigBenchmark.java b/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/LoggerConfigBenchmark.java
index a1293e5..8f1ca65 100644
--- a/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/LoggerConfigBenchmark.java
+++ b/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/LoggerConfigBenchmark.java
@@ -37,17 +37,6 @@
import org.openjdk.jmh.annotations.State;
import org.openjdk.jmh.infra.Blackhole;
-// ============================== HOW TO RUN THIS TEST: ====================================
-//
-// In sampling mode (latency test):
-// java -jar log4j-perf/target/benchmarks.jar ".*LoggerConfigBenchmark.*" -i 10 -f 1 -wi 5 -bm sample -tu ns
-//
-// Multi-threading test:
-// java -jar benchmarks.jar ".*LoggerConfigBenchmark.*" -i 10 -f 1 -wi 5 -bm sample -tu ns -t 4
-//
-// Usage help:
-// java -jar log4j-perf/target/benchmarks.jar -help
-//
@State(Scope.Benchmark)
public class LoggerConfigBenchmark {
diff --git a/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/LoggingDisabledBenchmark.java b/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/LoggingDisabledBenchmark.java
index 2d629bf..e18676d 100644
--- a/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/LoggingDisabledBenchmark.java
+++ b/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/LoggingDisabledBenchmark.java
@@ -30,22 +30,6 @@
import org.openjdk.jmh.annotations.TearDown;
import org.slf4j.LoggerFactory;
-// import com.newrelic.api.agent.Trace;
-
-/**
- * Benchmark logging with logging disabled.
- * // ============================== HOW TO RUN THIS TEST: ====================================
- * //
- * // single thread:
- * // java -jar log4j-perf/target/benchmarks.jar ".*LoggingDisabledBenchmark.*" -f 1 -wi 5 -i 10
- * //
- * // multiple threads (for example, 4 threads):
- * // java -jar log4j-perf/target/benchmarks.jar ".*LoggingDisabledBenchmark.*" -f 1 -wi 5 -i 10 -t 4 -si true
- * //
- * // Usage help:
- * // java -jar log4j-perf/target/benchmarks.jar -help
- * //
- */
@State(Scope.Thread)
public class LoggingDisabledBenchmark {
diff --git a/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/MDCFilterBenchmark.java b/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/MDCFilterBenchmark.java
index c6ca5e7..6491331 100644
--- a/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/MDCFilterBenchmark.java
+++ b/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/MDCFilterBenchmark.java
@@ -31,13 +31,6 @@
/**
* Benchmarks Log4j 2 and Logback ThreadContext/MDC Filter performance.
*/
-// HOW TO RUN THIS TEST
-// single thread:
-// java -jar target/benchmarks.jar ".*MDCFilterBenchmark.*" -f 1 -i 5 -wi 5 -bm sample -tu ns
-//
-// multiple threads (for example, 4 threads):
-// java -jar target/benchmarks.jar ".*MDCFilterBenchmark.*" -f 1 -i 5 -wi 5 -t 4 -si true -bm sample -tu ns
-
@State(Scope.Benchmark)
public class MDCFilterBenchmark {
// Loggers are Benchmark scope, just like in a real application:
diff --git a/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/MarkerFilterBenchmark.java b/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/MarkerFilterBenchmark.java
index 522168a..dc771d5 100644
--- a/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/MarkerFilterBenchmark.java
+++ b/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/MarkerFilterBenchmark.java
@@ -32,11 +32,6 @@
* Benchmarks Log4j 2 and Logback using a global MarkerFilter which will not be matched for this test. The Marker
* provided will have a
*/
-// HOW TO RUN THIS TEST
-// single thread:
-// java -jar target/benchmarks.jar ".*MarkerFilterBenchmark.*" -f 1 -i 5 -wi 5 -bm sample -tu ns
-// multiple threads (for example, 4 threads):
-// java -jar target/benchmarks.jar ".*MarkerFilterBenchmark.*" -f 1 -i 5 -wi 5 -t 4 -si true -bm sample -tu ns
@State(Scope.Benchmark)
public class MarkerFilterBenchmark {
Logger log4jLogger;
diff --git a/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/MemoryHandlerJULBenchmark.java b/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/MemoryHandlerJULBenchmark.java
index d191f0a..22503e8 100644
--- a/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/MemoryHandlerJULBenchmark.java
+++ b/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/MemoryHandlerJULBenchmark.java
@@ -46,17 +46,6 @@
* Tests JUL (java.util.logging) Memory Handler performance.
* We explicitly specify the location so that JUL will not try to look up caller location information.
*/
-// ============================== HOW TO RUN THIS TEST: ====================================
-//
-// single thread:
-// java -jar log4j-perf/target/benchmarks.jar ".*MemoryHandlerJULBenchmark.*" -f 1 -wi 10 -i 20
-//
-// multiple threads (for example, 4 threads):
-// java -jar log4j-perf/target/benchmarks.jar ".*MemoryHandlerJULBenchmark.*" -f 1 -wi 10 -i 20 -t 4 -si true
-//
-// Usage help:
-// java -jar log4j-perf/target/benchmarks.jar -help
-//
@State(Scope.Benchmark)
public class MemoryHandlerJULBenchmark {
diff --git a/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/MemoryHandlerJULLocationBenchmark.java b/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/MemoryHandlerJULLocationBenchmark.java
index c605773..e0ef429 100644
--- a/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/MemoryHandlerJULLocationBenchmark.java
+++ b/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/MemoryHandlerJULLocationBenchmark.java
@@ -34,17 +34,6 @@
/**
* Tests JUL (java.util.logging) Memory Handler performance when including caller location information.
*/
-// ============================== HOW TO RUN THIS TEST: ====================================
-//
-// single thread:
-// java -jar log4j-perf/target/benchmarks.jar ".*MemoryHandlerJULLocationBenchmark.*" -f 1 -wi 10 -i 20
-//
-// multiple threads (for example, 4 threads):
-// java -jar log4j-perf/target/benchmarks.jar ".*MemoryHandlerJULLocationBenchmark.*" -f 1 -wi 10 -i 20 -t 4 -si true
-//
-// Usage help:
-// java -jar log4j-perf/target/benchmarks.jar -help
-//
@State(Scope.Benchmark)
public class MemoryHandlerJULLocationBenchmark {
diff --git a/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/NamePatternConverterBenchmark.java b/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/NamePatternConverterBenchmark.java
index 3644b6c..1e7d080 100644
--- a/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/NamePatternConverterBenchmark.java
+++ b/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/NamePatternConverterBenchmark.java
@@ -34,18 +34,7 @@
import org.openjdk.jmh.annotations.Warmup;
/**
- * Tests Log4j2 NamePatternConverter's performance.<br>
- *
- * How to run these benchmarks:<br>
- *
- * Single thread:<br>
- * <pre>java -jar log4j-perf/target/benchmarks.jar ".*NamePatternConverterBenchmark.*" -f 1 -wi 2 -i 3 -r 3s -jvmArgs '-server -XX:+AggressiveOpts'</pre>
- *
- * Multiple threads (for example, 4 threads):<br>
- * <pre>java -jar log4j-perf/target/benchmarks.jar ".*NamePatternConverterBenchmark.*" -f 1 -wi 4 -i 20 -t 4 -si true</pre>
- *
- * Usage help:<br>
- * <pre>java -jar log4j-perf/target/benchmarks.jar -help</pre>
+ * Tests Log4j2 NamePatternConverter's performance.
*/
@Fork(1)
@Threads(1)
diff --git a/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/NanotimeBenchmark.java b/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/NanotimeBenchmark.java
index a63472a..13d1fa2 100644
--- a/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/NanotimeBenchmark.java
+++ b/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/NanotimeBenchmark.java
@@ -27,17 +27,6 @@
/**
* From <a href="http://shipilev.net/blog/2014/nanotrusting-nanotime/">http://shipilev.net/blog/2014/nanotrusting-nanotime/</a>.
*/
-// ============================== HOW TO RUN THIS TEST: ====================================
-//
-// single thread:
-// java -jar log4j-perf/target/benchmarks.jar ".*Nanotime.*" -f 1 -wi 5 -i 5
-//
-// multiple threads (for example, 4 threads):
-// java -jar log4j-perf/target/benchmarks.jar ".*Nanotime.*" -f 1 -wi 5 -i 5 -t 4 -si true
-//
-// Usage help:
-// java -jar log4j-perf/target/benchmarks.jar -help
-//
@State(Scope.Benchmark)
public class NanotimeBenchmark {
diff --git a/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/OutputBenchmark.java b/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/OutputBenchmark.java
index 3129122..20e75d2 100644
--- a/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/OutputBenchmark.java
+++ b/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/OutputBenchmark.java
@@ -36,11 +36,6 @@
* Benchmarks Log4j 2, Log4j 1, Logback and JUL using the DEBUG level which is enabled for this test. The configuration
* for each uses a FileAppender
*/
-// HOW TO RUN THIS TEST
-// java -jar log4j-perf/target/benchmarks.jar ".*OutputBenchmark.*" -f 1 -wi 10 -i 20
-//
-// RUNNING THIS TEST WITH 4 THREADS:
-// java -jar log4j-perf/target/benchmarks.jar ".*OutputBenchmark.*" -f 1 -wi 10 -i 20 -t 4
@State(Scope.Thread)
public class OutputBenchmark {
public static final String MESSAGE = "This is a debug message";
diff --git a/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/ParameterizedMessageBenchmark.java b/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/ParameterizedMessageBenchmark.java
index b4a7011..cae44b4 100644
--- a/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/ParameterizedMessageBenchmark.java
+++ b/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/ParameterizedMessageBenchmark.java
@@ -25,19 +25,6 @@
import org.openjdk.jmh.annotations.Scope;
import org.openjdk.jmh.annotations.State;
-/**
- */
-// ============================== HOW TO RUN THIS TEST: ====================================
-//
-// single thread:
-// java -jar log4j-perf/target/benchmarks.jar ".*ParameterizedMessageBench.*" -f 1 -wi 5 -i 10
-//
-// multiple threads (for example, 4 threads):
-// java -jar log4j-perf/target/benchmarks.jar ".*ParameterizedMessageBench.*" -f 1 -wi 5 -i 10 -t 4 -si true
-//
-// Usage help:
-// java -jar log4j-perf/target/benchmarks.jar -help
-//
@State(Scope.Benchmark)
public class ParameterizedMessageBenchmark {
private static final Object[] ARGS = {"arg1", "arg2"};
diff --git a/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/ParameterizedMessageInliningBenchmark.java b/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/ParameterizedMessageInliningBenchmark.java
index 9df035f..37fd373 100644
--- a/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/ParameterizedMessageInliningBenchmark.java
+++ b/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/ParameterizedMessageInliningBenchmark.java
@@ -26,19 +26,6 @@
import org.openjdk.jmh.annotations.Scope;
import org.openjdk.jmh.annotations.State;
-/**
- */
-// ============================== HOW TO RUN THIS TEST: ====================================
-//
-// single thread:
-// java -jar log4j-perf/target/benchmarks.jar ".*ParameterizedMessageInlining.*" -f 1 -wi 5 -i 10
-//
-// multiple threads (for example, 4 threads):
-// java -jar log4j-perf/target/benchmarks.jar ".*ParameterizedMessageInlining.*" -f 1 -wi 5 -i 10 -t 4 -si true
-//
-// Usage help:
-// java -jar log4j-perf/target/benchmarks.jar -help
-//
@State(Scope.Benchmark)
public class ParameterizedMessageInliningBenchmark {
private static final char DELIM_START = '{';
diff --git a/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/PatternLayoutBenchmark.java b/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/PatternLayoutBenchmark.java
index 5a8d99e..56fdd38 100644
--- a/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/PatternLayoutBenchmark.java
+++ b/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/PatternLayoutBenchmark.java
@@ -37,16 +37,6 @@
/**
* Tests Log4j2 PatternLayout performance.
*/
-// ============================== HOW TO RUN THIS TEST: ====================================
-//
-// single thread:
-// java -jar log4j-perf/target/benchmarks.jar ".*PatternLayoutBench.*" -f 1 -wi 5 -i 10
-// java -Dfile.encoding=UTF8 -jar log4j-perf/target/benchmarks.jar ".*PatternLayoutBench.*" -f 1 -wi 5 -i 10
-// java -Dfile.encoding=ISO-8859-1 -jar log4j-perf/target/benchmarks.jar ".*PatternLayoutBench.*" -f 1 -wi 5 -i 10
-//
-// Usage help:
-// java -jar log4j-perf/target/benchmarks.jar -help
-//
@State(Scope.Thread)
public class PatternLayoutBenchmark {
diff --git a/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/PatternLayoutComparisonBenchmark.java b/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/PatternLayoutComparisonBenchmark.java
index cd72253..1122811 100644
--- a/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/PatternLayoutComparisonBenchmark.java
+++ b/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/PatternLayoutComparisonBenchmark.java
@@ -41,14 +41,6 @@
/**
* Compares Log4j2 with Logback PatternLayout performance.
*/
-// ============================== HOW TO RUN THIS TEST: ====================================
-//
-// single thread:
-// java -jar log4j-perf/target/benchmarks.jar ".*PatternLayoutComparison.*" -f 1 -wi 10 -i 10 -tu ns -bm sample
-//
-// Usage help:
-// java -jar log4j-perf/target/benchmarks.jar -help
-//
@State(Scope.Thread)
public class PatternLayoutComparisonBenchmark {
diff --git a/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/ReflectionBenchmark.java b/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/ReflectionBenchmark.java
index d2cf833..19272c2 100644
--- a/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/ReflectionBenchmark.java
+++ b/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/ReflectionBenchmark.java
@@ -29,20 +29,7 @@
import org.openjdk.jmh.annotations.State;
/**
- * <p>
- * Benchmarks the different ways the caller class can be obtained. To run this in sampling mode (latency test):
- * </p>
- *
- * <pre>
- * java -jar benchmarks.jar ".*ReflectionBenchmark.*" -i 5 -f 1 -wi 5 -bm sample -tu ns
- * </pre>
- * <p>
- * To run this in throughput testing mode:
- * </p>
- *
- * <pre>
- * java -jar benchmarks.jar ".*ReflectionBenchmark.*" -i 5 -f 1 -wi 5 -bm Throughput -tu ms
- * </pre>
+ * Benchmarks the different ways the caller class can be obtained.
*/
public class ReflectionBenchmark {
diff --git a/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/SimpleBenchmark.java b/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/SimpleBenchmark.java
index 663faed..8009bec 100644
--- a/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/SimpleBenchmark.java
+++ b/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/SimpleBenchmark.java
@@ -37,13 +37,6 @@
/**
* Tests the overhead of disabled logging.
*/
-// ============================== HOW TO RUN THIS TEST: ====================================
-//
-// java -jar log4j-perf/target/benchmarks.jar ".*SimpleBenchmark.*" -f 1 -wi 5 -i 5
-//
-// Usage help:
-// java -jar log4j-perf/target/benchmarks.jar -help
-//
@State(Scope.Thread)
public class SimpleBenchmark {
private static final String msg = "This is a test";
diff --git a/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/SortedArrayVsHashMapBenchmark.java b/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/SortedArrayVsHashMapBenchmark.java
index 8f1b29d..b056291 100644
--- a/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/SortedArrayVsHashMapBenchmark.java
+++ b/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/SortedArrayVsHashMapBenchmark.java
@@ -38,17 +38,6 @@
/**
* Compares performance of SortedArrayStringMap vs. OpenHashMap vs. JDK HashMap.
*/
-// ============================== HOW TO RUN THIS TEST: ====================================
-// (Quick build: mvn -DskipTests=true clean package -pl log4j-perf -am )
-//
-// single thread:
-// java -jar log4j-perf/target/benchmarks.jar ".*SortedArrayVsHashMapBenchmark.*" -f 1 -wi 10 -i 20 -tu ns -bm sample
-//
-//
-// Usage help:
-// java -jar log4j-perf/target/benchmarks.jar -help
-//
-
@BenchmarkMode(Mode.AverageTime)
@OutputTimeUnit(TimeUnit.NANOSECONDS)
@Warmup(iterations = 5, time = 1, timeUnit = TimeUnit.SECONDS)
diff --git a/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/StackWalkBenchmark.java b/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/StackWalkBenchmark.java
index bd5c421..c581b40 100644
--- a/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/StackWalkBenchmark.java
+++ b/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/StackWalkBenchmark.java
@@ -31,17 +31,6 @@
/**
* Benchmark logging with logging disabled.
- * // ============================== HOW TO RUN THIS TEST: ====================================
- * //
- * // single thread:
- * // java -jar log4j-perf/target/benchmarks.jar ".*StackWalkBenchmark.*" -f 1 -wi 5 -i 10
- * //
- * // multiple threads (for example, 4 threads):
- * // java -jar log4j-perf/target/benchmarks.jar ".*StackWalkBenchmark.*" -f 1 -wi 5 -i 10 -t 4 -si true
- * //
- * // Usage help:
- * // java -jar log4j-perf/target/benchmarks.jar -help
- * //
*/
@State(Scope.Benchmark)
@BenchmarkMode(Mode.AverageTime)
diff --git a/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/StringBuilderEscapeBenchmark.java b/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/StringBuilderEscapeBenchmark.java
index 4c220457..f4ba45f 100644
--- a/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/StringBuilderEscapeBenchmark.java
+++ b/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/StringBuilderEscapeBenchmark.java
@@ -28,13 +28,6 @@
/**
* This benchmark tests encoding implementations.
*/
-// ============================== HOW TO RUN THIS TEST: ====================================
-//
-// java -jar log4j-perf/target/benchmarks.jar ".*StringBuilderEscapeBenchmark.*" -f 1 -wi 5 -i 10
-//
-// Usage help:
-// java -jar log4j-perf/target/benchmarks.jar -help
-//
@State(Scope.Benchmark)
public class StringBuilderEscapeBenchmark {
diff --git a/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/StringEncodingBenchmark.java b/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/StringEncodingBenchmark.java
index a02819b..4369518 100644
--- a/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/StringEncodingBenchmark.java
+++ b/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/StringEncodingBenchmark.java
@@ -32,17 +32,6 @@
/**
* Tests Log4j2 StringEncoding performance.
*/
-// ============================== HOW TO RUN THIS TEST: ====================================
-// (Quick build: mvn -DskipTests=true clean package -pl log4j-perf -am )
-//
-// java -jar log4j-perf/target/benchmarks.jar ".*StringEncoding.*" -f 1 -wi 5 -i 10
-//
-// Latency numbers instead of throughput:
-// java -jar log4j-perf/target/benchmarks.jar ".*StringEncoding.*" -f 1 -wi 5 -i 10 -tu ns -bm sample
-//
-// Usage help:
-// java -jar log4j-perf/target/benchmarks.jar -help
-//
@State(Scope.Thread)
public class StringEncodingBenchmark {
diff --git a/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/TextEncoderHelperBenchmark.java b/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/TextEncoderHelperBenchmark.java
index 6c55bad..f706d84 100644
--- a/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/TextEncoderHelperBenchmark.java
+++ b/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/TextEncoderHelperBenchmark.java
@@ -42,17 +42,6 @@
/**
* Tests Log4j2 StringBuilderEncoder performance.
*/
-// ============================== HOW TO RUN THIS TEST: ====================================
-//
-// single thread:
-// java -Dfile.encoding=ISO-8859-1 -Dlog4j2.enableThreadlocals=true -jar
-// log4j-perf/target/benchmarks.jar ".*StringBuilderEncoder.*" -f 1 -wi 5 -i 10
-// java -Dfile.encoding=UTF8 -Dlog4j2.enableThreadlocals=true -jar
-// log4j-perf/target/benchmarks.jar ".*StringBuilderEncoder.*" -f 1 -wi 5 -i 10
-//
-// Usage help:
-// java -jar log4j-perf/target/benchmarks.jar -help
-//
@State(Scope.Thread)
public class TextEncoderHelperBenchmark {
diff --git a/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/ThreadContextBenchmark.java b/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/ThreadContextBenchmark.java
index a037085..653028c 100644
--- a/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/ThreadContextBenchmark.java
+++ b/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/ThreadContextBenchmark.java
@@ -50,18 +50,6 @@
/**
* Compares performance of ThreadContextMap implementations.
*/
-// ============================== HOW TO RUN THIS TEST: ====================================
-// (Quick build: mvn -DskipTests=true clean package -pl log4j-perf -am )
-//
-// single thread:
-// java -jar log4j-perf/target/benchmarks.jar ".*ThreadContextBench.*"
-//
-// four threads:
-// java -jar log4j-perf/target/benchmarks.jar ".*ThreadContextBench.*" -f 1 -wi 10 -i 20 -tu ns -bm sample -t 4
-//
-// Usage help:
-// java -jar log4j-perf/target/benchmarks.jar -help
-//
@BenchmarkMode(Mode.AverageTime)
@OutputTimeUnit(TimeUnit.NANOSECONDS)
@Warmup(iterations = 5, time = 1, timeUnit = TimeUnit.SECONDS)
diff --git a/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/ThreadContextBenchmark2.java b/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/ThreadContextBenchmark2.java
index 7d5c29e..3c16cae 100644
--- a/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/ThreadContextBenchmark2.java
+++ b/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/ThreadContextBenchmark2.java
@@ -46,16 +46,6 @@
/**
* Compares performance of ThreadContextMap implementations and ScopedContext
*/
-// ============================== HOW TO RUN THIS TEST: ====================================
-// (Quick build: mvn -DskipTests=true clean package -pl log4j-perf -am )
-//
-// single thread:
-// java -jar log4j-perf/target/benchmarks.jar ".*ThreadContextBenchmark2.*"
-//
-// Usage help:
-// java -jar log4j-perf/target/benchmarks.jar -help
-//
-
@BenchmarkMode(Mode.AverageTime)
@OutputTimeUnit(TimeUnit.NANOSECONDS)
public class ThreadContextBenchmark2 {
diff --git a/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/ThreadLocalVsConcurrentHashMapBenchmark.java b/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/ThreadLocalVsConcurrentHashMapBenchmark.java
index fff26ce..4e9ec60 100644
--- a/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/ThreadLocalVsConcurrentHashMapBenchmark.java
+++ b/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/ThreadLocalVsConcurrentHashMapBenchmark.java
@@ -24,19 +24,6 @@
/**
* Compares performance of ThreadLocal, vs ConcurrentHashMap<Thread, Object>.
*/
-// ============================== HOW TO RUN THIS TEST: ====================================
-// (Quick build: mvn -DskipTests=true clean package -pl log4j-perf -am )
-//
-// single thread:
-// java -jar log4j-perf/target/benchmarks.jar ".*ThreadLocalVsConcurrentHashMap.*" -f 1 -wi 10 -i 20 -tu ns -bm sample
-//
-// four threads:
-// java -jar log4j-perf/target/benchmarks.jar ".*ThreadLocalVsConcurrentHashMap.*" -f 1 -wi 10 -i 20 -tu ns -bm sample
-// -t 4
-//
-// Usage help:
-// java -jar log4j-perf/target/benchmarks.jar -help
-//
@State(Scope.Benchmark)
public class ThreadLocalVsConcurrentHashMapBenchmark {
diff --git a/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/ThreadLocalVsPoolBenchmark.java b/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/ThreadLocalVsPoolBenchmark.java
index 8623eed..829db1b 100644
--- a/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/ThreadLocalVsPoolBenchmark.java
+++ b/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/ThreadLocalVsPoolBenchmark.java
@@ -36,18 +36,6 @@
* Checks {@link PatternFormatter} performance with various StringBuilder
* caching strategies: no-op, ThreadLocal, and JCTools MPMC queue.
*/
-// ============================== HOW TO RUN THIS TEST: ====================================
-// (Quick build: mvn -DskipTests=true clean package -pl log4j-perf -am )
-//
-// single thread:
-// java -jar log4j-perf/target/benchmarks.jar ".*ThreadLocalVsPool.*" -f 1 -wi 10 -i 20 -tu ns -bm sample
-//
-// four threads:
-// java -jar log4j-perf/target/benchmarks.jar ".*ThreadLocalVsPool.*" -f 1 -wi 10 -i 20 -tu ns -bm sample -t 4
-//
-// Usage help:
-// java -jar log4j-perf/target/benchmarks.jar -help
-//
@State(Scope.Benchmark)
public class ThreadLocalVsPoolBenchmark {
diff --git a/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/ThreadsafeDateFormatBenchmark.java b/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/ThreadsafeDateFormatBenchmark.java
index 95572ec..0fe3c33 100644
--- a/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/ThreadsafeDateFormatBenchmark.java
+++ b/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/ThreadsafeDateFormatBenchmark.java
@@ -34,17 +34,6 @@
/**
* Tests performance of various DateFormatters in a thread-safe manner.
*/
-// ============================== HOW TO RUN THIS TEST: ====================================
-//
-// single thread:
-// java -jar log4j-perf/target/benchmarks.jar ".*ThreadsafeDateFormat.*" -f 1 -wi 5 -i 10
-//
-// multiple threads (for example, 4 threads):
-// java -jar log4j-perf/target/benchmarks.jar ".*ThreadsafeDateFormat.*" -f 1 -wi 5 -i 10 -t 4 -si true
-//
-// Usage help:
-// java -jar log4j-perf/target/benchmarks.jar -help
-//
@State(Scope.Benchmark)
public class ThreadsafeDateFormatBenchmark {
diff --git a/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/TimeFormatBenchmark.java b/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/TimeFormatBenchmark.java
index 4140b7f..0a59cb2 100644
--- a/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/TimeFormatBenchmark.java
+++ b/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/TimeFormatBenchmark.java
@@ -33,17 +33,6 @@
/**
* Tests performance of various time format implementation.
*/
-// ============================== HOW TO RUN THIS TEST: ====================================
-//
-// single thread:
-// java -jar log4j-perf/target/benchmarks.jar ".*TimeFormat.*" -f 1 -wi 5 -i 10
-//
-// multiple threads (for example, 4 threads):
-// java -jar log4j-perf/target/benchmarks.jar ".*TimeFormat.*" -f 1 -wi 5 -i 5 -t 4 -si true
-//
-// Usage help:
-// java -jar log4j-perf/target/benchmarks.jar -help
-//
@State(Scope.Benchmark)
public class TimeFormatBenchmark {
diff --git a/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/UnboxBenchmark.java b/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/UnboxBenchmark.java
index 0f3ec28..b3e3e62 100644
--- a/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/UnboxBenchmark.java
+++ b/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/UnboxBenchmark.java
@@ -28,20 +28,6 @@
/**
* Benchmarks the Unbox class.
*/
-// ============================== HOW TO RUN THIS TEST: ====================================
-//
-// single thread:
-// java -jar log4j-perf/target/benchmarks.jar ".*Unbox.*" -f 1 -wi 10 -i 15
-//
-// Default config with multiple threads (for example, 4 threads):
-// java -Dlog4j2.enable.threadlocals=true -jar log4j-perf/target/benchmarks.jar ".*Unbox.*" -f 1 -wi 10 -i 15 -t 4
-//
-// Web-app safe config with multiple threads (for example, 4 threads):
-// java -Dlog4j2.enable.threadlocals=false -jar log4j-perf/target/benchmarks.jar ".*Unbox.*" -f 1 -wi 10 -i 15 -t 4
-//
-// Usage help:
-// java -jar log4j-perf/target/benchmarks.jar -help
-//
@State(Scope.Benchmark)
public class UnboxBenchmark {
diff --git a/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/UuidGeneratorBenchmark.java b/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/UuidGeneratorBenchmark.java
index fc2eb74..a6df5bf 100644
--- a/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/UuidGeneratorBenchmark.java
+++ b/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/UuidGeneratorBenchmark.java
@@ -23,13 +23,6 @@
/**
* Compares random UUID generation with time-based UUID generation.
*/
-// ============================== HOW TO RUN THIS TEST: ====================================
-//
-// java -jar log4j-perf/target/benchmarks.jar ".*UuidGeneratorBenchmark.*" -f 1 -wi 5 -i 5
-//
-// Usage help:
-// java -jar log4j-perf/target/benchmarks.jar -help
-//
public class UuidGeneratorBenchmark {
@Benchmark
diff --git a/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/VarargsBenchmark.java b/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/VarargsBenchmark.java
index 6dab8e2..dcb3a5a 100644
--- a/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/VarargsBenchmark.java
+++ b/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/VarargsBenchmark.java
@@ -27,17 +27,6 @@
/**
* Tests how expensive constructing a varargs array is.
*/
-// ============================== HOW TO RUN THIS TEST: ====================================
-//
-// single thread:
-// java -jar log4j-perf/target/benchmarks.jar ".*Varargs.*" -f 1 -wi 5 -i 10
-//
-// multiple threads (for example, 4 threads):
-// java -jar log4j-perf/target/benchmarks.jar ".*Varargs.*" -f 1 -wi 5 -i 10 -t 4 -si true
-//
-// Usage help:
-// java -jar log4j-perf/target/benchmarks.jar -help
-//
@State(Scope.Benchmark)
public class VarargsBenchmark {
diff --git a/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/package-info.java b/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/package-info.java
deleted file mode 100644
index 3df2492..0000000
--- a/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/jmh/package-info.java
+++ /dev/null
@@ -1,23 +0,0 @@
-/*
- * Licensed to the Apache Software Foundation (ASF) under one or more
- * contributor license agreements. See the NOTICE file distributed with
- * this work for additional information regarding copyright ownership.
- * The ASF licenses this file to You 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
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the license for the specific language governing permissions and
- * limitations under the license.
- */
-/**
- * <p>Benchmark tests for Log4j. For general usage help, run:</p>
- * <pre>
- * java -jar microbenchmarks.jar -help
- * </pre>
- */
-package org.apache.logging.log4j.perf.jmh;
diff --git a/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/nogc/Test.java b/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/nogc/Test.java
deleted file mode 100644
index 024cc3b..0000000
--- a/log4j-perf-test/src/main/java/org/apache/logging/log4j/perf/nogc/Test.java
+++ /dev/null
@@ -1,116 +0,0 @@
-/*
- * Licensed to the Apache Software Foundation (ASF) under one or more
- * contributor license agreements. See the NOTICE file distributed with
- * this work for additional information regarding copyright ownership.
- * The ASF licenses this file to you 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
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-package org.apache.logging.log4j.perf.nogc;
-
-import static org.apache.logging.log4j.util.Unbox.box;
-
-import java.util.Date;
-
-/**
- * Tests the classic Log4j2 components.
- * <p>
- * Run CLASSIC test (varargs, ParameterizedMessage, PatternLayout(%m)):
- * java -Xms64M -Xmx64M -cp log4j-perf/target/benchmarks.jar -verbose:gc -XX:+PrintGCDetails -XX:+PrintGCTimeStamps -XX:+PrintGCApplicationStoppedTime org.apache.logging.log4j.perf.nogc.Test Classic
- *
- * Run NOGC test (unrolled varargs, StringBuilderMessage, NoGcLayout(%m)):
- * java -Xms64M -Xmx64M -cp log4j-perf/target/benchmarks.jar -verbose:gc -XX:+PrintGCDetails -XX:+PrintGCTimeStamps -XX:+PrintGCApplicationStoppedTime org.apache.logging.log4j.perf.nogc.Test NoGC
- *
- * </p>
- */
-public class Test {
- private static final int COUNT = 10;
- private static final int REPETITIONS = 1000000;
- static long[] startTime = new long[COUNT];
- static long[] duration = new long[COUNT];
- static long[] checksums = new long[COUNT];
-
- public static void main(final String[] args) throws Exception {
- if ("Classic".equalsIgnoreCase(args[0])) {
- final ClassicLogger logger = new ClassicLogger();
- runTestSuite(logger);
- } else if ("NoGC".equalsIgnoreCase(args[0])) {
- final NoGcLogger logger = new NoGcLogger();
- runTestSuite(logger);
- } else {
- throw new IllegalArgumentException("Specify either Classic or NoGC");
- // ClassicLogger classic = new ClassicLogger();
- // NoGcLogger nogc = new NoGcLogger();
- // doTestRunBoth(classic, nogc, REPETITIONS, 0);
- }
- reportResults(args[0]);
- }
-
- private static void runTestSuite(final ClassicLogger logger) throws Exception {
- for (int i = 0; i < 10; i++) {
- doTestRun(logger, REPETITIONS, i);
- Thread.sleep(100);
- }
- }
-
- private static void runTestSuite(final NoGcLogger logger) throws Exception {
- for (int i = 0; i < 10; i++) {
- doTestRun(logger, REPETITIONS, i);
- Thread.sleep(100);
- }
- }
-
- private static void doTestRun(final NoGcLogger logger, final int repetitions, final int n) {
- startTime[n] = System.currentTimeMillis();
- final long start = System.nanoTime();
- for (int i = 0; i < repetitions; i++) {
- logger.log("Test message str={}, double={}, int={}, obj={}", "abc", box(i / 2.5), box(i), "XYX");
- // logger.log("Test message str={}, double={}, int={}, obj={}", "abc", (i / 2.5), (i), logger);
- }
- duration[n] = System.nanoTime() - start;
- checksums[n] = logger.appender.checksum;
- logger.appender.checksum = 0;
- }
-
- private static void doTestRun(final ClassicLogger logger, final int repetitions, final int n) {
- startTime[n] = System.currentTimeMillis();
- final long start = System.nanoTime();
- for (int i = 0; i < repetitions; i++) {
- logger.log("Test message str={}, double={}, int={}, obj={}", "abc", i / 2.5, i, "XYX");
- }
- duration[n] = System.nanoTime() - start;
- checksums[n] = logger.appender.checksum;
- logger.appender.checksum = 0;
- }
-
- private static void doTestRunBoth(
- final ClassicLogger classic, final NoGcLogger nogc, final int repetitions, final int n) {
- startTime[n] = System.currentTimeMillis();
- final long start = System.nanoTime();
- for (int i = 0; i < repetitions; i++) {
- classic.log("Test message str={}, double={}, int={}, obj={}", "abc", i / 2.5, i, "XYX");
- nogc.log("Test message str={}, double={}, int={}, obj={}", "abc", box(i / 2.5), box(i), "XYX");
-
- if (classic.appender.checksum != nogc.appender.checksum) {
- throw new IllegalStateException();
- }
- }
- duration[n] = System.nanoTime() - start;
- }
-
- private static void reportResults(final String type) {
- for (int i = 0; i < COUNT; i++) {
- System.out.printf(
- "%s[%d] (%3$tF %3$tT.%3$tL) took %4$,d ns. CHECK=%5$s%n",
- type, i, new Date(startTime[i]), duration[i], Long.toHexString(checksums[i]));
- }
- }
-}
