flink-benchmarks

This repository contains sets of micro benchmarks designed to run on single machine to help Apache Flink's developers assess performance implications of their changes.

The main methods defined in the various classes (test cases) are using jmh micro benchmark suite to define runners to execute those test cases. You can execute the default benchmark suite (which takes ~1hour) at once:

mvn -Dflink.version=1.11-SNAPSHOT clean install exec:exec

There is also a separate benchmark suit for state backend, and you can execute this suit (which takes ~1hour) using below command:

mvn -Dflink.version=1.11-SNAPSHOT clean package exec:exec \
 -Dbenchmarks="org.apache.flink.state.benchmark.*"

If you want to execute just one benchmark, the best approach is to execute selected main function manually. There're mainly two ways:

  1. From your IDE (hint there is a plugin for Intellij IDEA).

    • In this case don't forget about selecting flink.version, default value for the property is defined in pom.xml.
  2. From command line, using command like:

    mvn -Dflink.version=1.11-SNAPSHOT clean package exec:exec \
    -Dbenchmarks="<benchmark_class>"

We also support to run each benchmark once (with only one fork and one iteration) for testing, with below command:

mvn test -P test

Prerequisites

The recent addition of OpenSSL-based benchmarks require one of two modes to be active:

If both options are not working, OpenSSL benchmarks will fail but that should not influence any other benchmarks.

Code structure

Recommended code structure is to define all benchmarks in Apache Flink and only wrap them here, in this repository, into executor classes.

Such code structured is due to using GPL2 licensed jmh library for the actual execution of the benchmarks. Ideally we would prefer to have all of the code moved to Apache Flink

General remarks

Naming convention

Regarding naming the benchmark methods, there is one important thing. When uploading the results to the codespeed web UI, uploader is using just the benchmark's method name combined with the parameters to generate visible name of the benchmark in the UI. Because of that it is important to:

  1. Have the method name explanatory enough so we can quickly recognize what the given benchmark is all about, using just the benchmark's method name.
  2. Be as short as possible to not bloat the web UI (so we must drop all of the redundant suffixes/prefixes, like benchmark, test, ...)
  3. Class name is completely ignored by the uploader.
  4. Method names should be unique across the project.

Good example of how to name benchmark methods are:

Submitting a pull request

Please attach the results of your benchmarks.