sscaling/java-flamegraph repository overview

⁠Java Flamegraph

Docker image to package together tooling for generating Flame graphs⁠ based loosely on codecentric blog⁠

Based on the official openjdk alpine docker image for Java 8.

This is available via Docker Hub⁠

⁠Building

docker build -t sscaling/java-flamegraph .

⁠Running

docker run --rm -v $PWD:/source sscaling/java-flamegraph [java arguments] > flamegraph.svg

NOTE: Due to honest-profiler configuring the -agentpath property, this should not be specified in the java arguments

The output will be an SVG file written to stdout

You may find this useful to configure an alias, so this can be easily executed

$ alias javafg='docker run -v $PWD:/source sscaling/java-flamegraph'
$ javafg -cp target/myproject-1.0-SNAPSHOT.jar com.sscaling.test.TestApp > results.svg

You can configure the profiler interval with the PROFILER_INTERVAL environment variable. By default this is 7.

⁠Notes

• Currently this uses openjdk, Java 8. If you have an application requiring a newer version of Java, this is likely to be incompatible.
• Currently requires the app to be self contained and already packaged. I.e. there is no support for Maven/Gradle/Ant. This means it is not a good fit for applications such as containerized webapps that are deployed into another process. However, it does mean that this image potentially has all the profiling dependencies configured and could be used as a base image if a more complicated environment is required.
• As per the license, software is provided as-is. This is just repackaging existing components - no original work is included in this project.