Skip to content

Setup JMH benchmarking #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
chrfwow wants to merge 1 commit into from
Closed

Setup JMH benchmarking #1

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .github/workflows/pullrequest.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,5 +54,8 @@ jobs:
fail_ci_if_error: true # optional (default = false)
verbose: true # optional (default = false)

- name: Run JMH benchmark
run: 'jmh:benchmark -rf json -rff output.json .*'

- name: Perform CodeQL Analysis
uses: github/codeql-action/analyze@624d0bca90f761ffa7ce50c41875a1a226969a02
20 changes: 19 additions & 1 deletion pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -167,7 +167,12 @@
<version>1.37</version>
<scope>test</scope>
</dependency>

<dependency>
<groupId>org.openjdk.jmh</groupId>
<artifactId>jmh-generator-annprocess</artifactId>
<version>1.37</version>
<scope>test</scope>
</dependency>
</dependencies>

<dependencyManagement>
Expand Down Expand Up @@ -703,6 +708,19 @@
</execution>
</executions>
</plugin>
<plugin>
<artifactId>maven-compiler-plugin</artifactId>
<version>3.8.1</version>
<configuration>
<annotationProcessorPaths>
<path>
<groupId>org.openjdk.jmh</groupId>
<artifactId>jmh-generator-annprocess</artifactId>
<version>1.37</version>
</path>
</annotationProcessorPaths>
</configuration>
</plugin>
</plugins>
</build>
</profile>
Expand Down
31 changes: 31 additions & 0 deletions src/bench/java/dev/openfeature/sdk/FlagEvaluationBenchmark.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
package dev.openfeature.sdk;

import dev.openfeature.sdk.state.FlagEvaluationState;
import java.util.concurrent.TimeUnit;
import dev.openfeature.sdk.state.HooksState;
import org.openjdk.jmh.annotations.Benchmark;
import org.openjdk.jmh.annotations.BenchmarkMode;
import org.openjdk.jmh.annotations.Fork;
import org.openjdk.jmh.annotations.Measurement;
import org.openjdk.jmh.annotations.Mode;
import org.openjdk.jmh.annotations.Warmup;


@BenchmarkMode(Mode.Throughput)
@Warmup(time = 1, timeUnit = TimeUnit.SECONDS, iterations = 1)
//@Warmup(time = 1, timeUnit = TimeUnit.SECONDS, iterations = 2)
@Measurement(time = 5, timeUnit = TimeUnit.SECONDS, iterations = 1)
//@Measurement(time = 5, timeUnit = TimeUnit.SECONDS, iterations = 4)
@Fork(1)
public class FlagEvaluationBenchmark {

@Benchmark
public String flagEvaluations(FlagEvaluationState state) {
return state.client.getStringDetails(FlagEvaluationState.FLAG_KEY, "default").getValue();
}

@Benchmark
public String hookExecution(HooksState state) {
return state.client.getStringDetails(HooksState.FLAG_KEY, "default").getValue();
}
}
45 changes: 45 additions & 0 deletions src/bench/java/dev/openfeature/sdk/state/FlagEvaluationState.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
package dev.openfeature.sdk.state;

import dev.openfeature.sdk.Client;
import dev.openfeature.sdk.ImmutableMetadata;
import dev.openfeature.sdk.OpenFeatureAPI;
import dev.openfeature.sdk.providers.memory.Flag;
import dev.openfeature.sdk.providers.memory.InMemoryProvider;
import org.openjdk.jmh.annotations.Level;
import org.openjdk.jmh.annotations.Scope;
import org.openjdk.jmh.annotations.Setup;
import org.openjdk.jmh.annotations.State;
import org.openjdk.jmh.annotations.TearDown;
import java.util.Map;

@State(Scope.Benchmark)
public class FlagEvaluationState {
public static final String FLAG_KEY = "flag-key";
public static final String DOMAIN = "jmh-domain";

public InMemoryProvider provider;
public Client client;

@Setup(Level.Trial)
public void setup() {
provider = new InMemoryProvider(
Map.of(
FLAG_KEY,
Flag.builder()
.variant("a", "a-value")
.variant("b", "b-value")
.defaultVariant("b")
.flagMetadata(ImmutableMetadata.builder().addString("meta", "data").build())
.build()
)
);
OpenFeatureAPI.getInstance().setProviderAndWait(DOMAIN, provider);
client = OpenFeatureAPI.getInstance().getClient(DOMAIN);
}

@TearDown(Level.Trial)
public void teardown() {
OpenFeatureAPI.getInstance().shutdown();
OpenFeatureAPI.getInstance().clearHooks();
}
}
48 changes: 48 additions & 0 deletions src/bench/java/dev/openfeature/sdk/state/HooksState.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
package dev.openfeature.sdk.state;

import dev.openfeature.sdk.Client;
import dev.openfeature.sdk.Hook;
import dev.openfeature.sdk.ImmutableMetadata;
import dev.openfeature.sdk.OpenFeatureAPI;
import dev.openfeature.sdk.StringHook;
import dev.openfeature.sdk.providers.memory.Flag;
import dev.openfeature.sdk.providers.memory.InMemoryProvider;
import java.util.Map;
import org.openjdk.jmh.annotations.Level;
import org.openjdk.jmh.annotations.Scope;
import org.openjdk.jmh.annotations.Setup;
import org.openjdk.jmh.annotations.State;
import org.openjdk.jmh.annotations.TearDown;

@State(Scope.Benchmark)
public class HooksState {
public static final String FLAG_KEY = "flag-key";
public static final String DOMAIN = "jmh-domain";

public InMemoryProvider provider;
public Client client;

@Setup(Level.Trial)
public void setup() {
provider = new InMemoryProvider(
Map.of(
FLAG_KEY,
Flag.builder()
.variant("a", "a-value")
.variant("b", "b-value")
.defaultVariant("b")
.flagMetadata(ImmutableMetadata.builder().addString("meta", "data").build())
.build()
)
);
OpenFeatureAPI.getInstance().setProviderAndWait(DOMAIN, provider);
client = OpenFeatureAPI.getInstance().getClient(DOMAIN);
client.addHooks(new StringHook() {}, new Hook() {});
}

@TearDown(Level.Trial)
public void teardown() {
OpenFeatureAPI.getInstance().shutdown();
OpenFeatureAPI.getInstance().clearHooks();
}
}
Loading