Skip to content

Commit 2f0fcfc

Browse files
skjolberskjolber
committed
JMH module
1 parent dd96d1b commit 2f0fcfc

17 files changed

Lines changed: 834 additions & 1 deletion

‎.gitignore‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,3 +7,12 @@ target/
77
/.mvn/wrapper/*.jar
88

99
*.log
10+
11+
### Eclipse ###
12+
.settings/
13+
.classpath
14+
.project
15+
.factorypath
16+
17+
### various ###
18+
jmh-result.json

‎logbook-jmh/README.md‎

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
# logbook-jmh
2+
Module for performance-testing using the [JMH](https://openjdk.java.net/projects/code-tools/jmh/) framework.
3+
4+
## Introduction
5+
Performance analysis is complicated due to the dynamic nature of the JVM Hotspot implementation.
6+
7+
For example the JVM Hotspot is affected by the classes it loads and better optimize when there is only one implementation of an interface in use.
8+
9+
In practice much of the dynamic nature can be handled by using so-called forks and warmups:
10+
11+
* forks makes sure the individual benchmarks run alone
12+
* warmups makes sure optimizations by the JVM Hotspot are finished before the measurements are taken
13+
14+
## Getting started
15+
Get familiar with JMH:
16+
17+
* [baeldung](https://www.baeldung.com/java-microbenchmark-harness)
18+
* [jenkov](http://tutorials.jenkov.com/java-performance/jmh.html)
19+
20+
Download a profiler like [VisualVM](https://visualvm.github.io/) for drilling down to method level during development.
21+
22+
In this project, there is end-to-end tests in the [LogbookBenchmark](src/main/java/org/zalando/logbook/LogbookBenchmark.java) which touches the most commonly used code paths.
23+
24+
Execute `LogbookBenchmark` using the command
25+
26+
```
27+
mvn clean package && java -jar logbook-jmh/target/benchmark.jar LogbookBenchmark -rf json
28+
```
29+
30+
and view the resulting `jmh-result.json` by dropping the file into a [visualizer](https://jmh.morethan.io).
31+
32+
Remember to disable CPU turbo / boost in BIOS, and close active programs competing for CPU resources.
33+
34+
### Performance analysis
35+
Analyze the source code, tweak the end-to-end and noop benchmarks and/or use a profiler to identify hotspots.
36+
37+
Benchmarks can be executed as standalone programs (using `main(..)` method) directly from your IDE. This is less accurate than running from the command line, but convenient during active development, especially for drilling down using a profiler like [VisualVM](https://visualvm.github.io/) or such.
38+
39+
## Writing a benchmark
40+
Once a potential hotspot is identified, capture the initial state by writing a baseline benchmark. If missing, add unit tests, so you're sure to be comparing apples to apples. Also add a (as close as possible) no-operation / pass-through benchmark to sanity-check the upper limit on your results. Please note that this will need to be submitted in its own PR.
41+
42+
Then add alternative implementations and their corresponding benchmarks. The benchmarks you want to compare go into the same class file (so that the visualizer presents them together).

‎logbook-jmh/pom.xml‎

Lines changed: 77 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,77 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<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">
3+
<modelVersion>4.0.0</modelVersion>
4+
<parent>
5+
<groupId>org.zalando</groupId>
6+
<artifactId>logbook-parent</artifactId>
7+
<version>2.0.0-SNAPSHOT</version>
8+
</parent>
9+
<artifactId>logbook-jmh</artifactId>
10+
<name>Logbook: JMH</name>
11+
<description>JMH Benchmarks for Logbook</description>
12+
<scm>
13+
<url>https://github.com/zalando/logbook</url>
14+
<connection>scm:git:git@github.com:zalando/logbook.git</connection>
15+
<developerConnection>scm:git:git@github.com:zalando/logbook.git</developerConnection>
16+
</scm>
17+
<dependencies>
18+
<dependency>
19+
<groupId>org.zalando</groupId>
20+
<artifactId>logbook-api</artifactId>
21+
</dependency>
22+
<dependency>
23+
<groupId>org.zalando</groupId>
24+
<artifactId>logbook-json</artifactId>
25+
</dependency>
26+
<dependency>
27+
<groupId>org.zalando</groupId>
28+
<artifactId>logbook-spring-boot-autoconfigure</artifactId>
29+
</dependency>
30+
<dependency>
31+
<groupId>org.zalando</groupId>
32+
<artifactId>logbook-common</artifactId>
33+
</dependency>
34+
<dependency>
35+
<groupId>com.fasterxml.jackson.core</groupId>
36+
<artifactId>jackson-databind</artifactId>
37+
</dependency>
38+
<dependency>
39+
<groupId>com.fasterxml.jackson.core</groupId>
40+
<artifactId>jackson-annotations</artifactId>
41+
</dependency>
42+
<dependency>
43+
<groupId>org.zalando</groupId>
44+
<artifactId>logbook-test</artifactId>
45+
<scope>compile</scope>
46+
</dependency>
47+
<dependency>
48+
<groupId>org.openjdk.jmh</groupId>
49+
<artifactId>jmh-core</artifactId>
50+
</dependency>
51+
<dependency>
52+
<groupId>org.openjdk.jmh</groupId>
53+
<artifactId>jmh-generator-annprocess</artifactId>
54+
<scope>provided</scope>
55+
</dependency>
56+
<dependency>
57+
<groupId>org.zalando</groupId>
58+
<artifactId>logbook-logstash</artifactId>
59+
</dependency>
60+
</dependencies>
61+
62+
<build>
63+
<plugins>
64+
<plugin>
65+
<groupId>org.apache.maven.plugins</groupId>
66+
<artifactId>maven-shade-plugin</artifactId>
67+
</plugin>
68+
<plugin>
69+
<groupId>org.jacoco</groupId>
70+
<artifactId>jacoco-maven-plugin</artifactId>
71+
<configuration>
72+
<skip>true</skip>
73+
</configuration>
74+
</plugin>
75+
</plugins>
76+
</build>
77+
</project>

‎logbook-jmh/src/main/java/org/zalando/logbook/HeaderBenchmark.java‎

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
package org.zalando.logbook;
2+
3+
import java.io.IOException;
4+
import java.util.concurrent.TimeUnit;
5+
6+
import org.openjdk.jmh.annotations.Benchmark;
7+
import org.openjdk.jmh.annotations.BenchmarkMode;
8+
import org.openjdk.jmh.annotations.Fork;
9+
import org.openjdk.jmh.annotations.Measurement;
10+
import org.openjdk.jmh.annotations.Mode;
11+
import org.openjdk.jmh.annotations.Warmup;
12+
import org.openjdk.jmh.runner.Runner;
13+
import org.openjdk.jmh.runner.RunnerException;
14+
import org.openjdk.jmh.runner.options.Options;
15+
import org.openjdk.jmh.runner.options.OptionsBuilder;
16+
17+
@Fork(value = 1, warmups = 1)
18+
@Warmup(iterations = 5, time = 10, timeUnit = TimeUnit.SECONDS)
19+
@BenchmarkMode(Mode.Throughput)
20+
@Measurement(iterations = 5, time = 10, timeUnit = TimeUnit.SECONDS)
21+
public class HeaderBenchmark {
22+
23+
@Benchmark
24+
public void autoconfigurationRequest(HeaderState headerState) throws IOException {
25+
headerState.getAutoconfigurationFilter().filter(headerState.getAllRequestHeaders());
26+
}
27+
28+
@Benchmark
29+
public void autoconfigurationResponse(HeaderState headerState) throws IOException {
30+
headerState.getAutoconfigurationFilter().filter(headerState.getAllResponseHeaders());
31+
}
32+
33+
@Benchmark
34+
public void replace1xRequest(HeaderState headerState) throws IOException {
35+
headerState.getReplaceFilter().filter(headerState.getAllRequestHeaders());
36+
}
37+
38+
@Benchmark
39+
public void replace1xResponse(HeaderState headerState) throws IOException {
40+
headerState.getReplaceFilter().filter(headerState.getAllResponseHeaders());
41+
}
42+
43+
@Benchmark
44+
public void replace2xRequest(HeaderState headerState) throws IOException {
45+
headerState.getReplace2xFilter().filter(headerState.getAllRequestHeaders());
46+
}
47+
48+
@Benchmark
49+
public void replace2xResponse(HeaderState headerState) throws IOException {
50+
headerState.getReplace2xFilter().filter(headerState.getAllResponseHeaders());
51+
}
52+
53+
@Benchmark
54+
public void replace2xResponseShopify(HeaderState headerState) throws IOException {
55+
headerState.getReplace2xFilter().filter(headerState.getShopifyResponseHeaders());
56+
}
57+
58+
public static void main(String[] args) throws RunnerException {
59+
Options options = new OptionsBuilder().include(HeaderBenchmark.class.getSimpleName())
60+
.forks(1).build();
61+
new Runner(options).run();
62+
}
63+
}

0 commit comments

Comments
 (0)