Quickstart Guide

This is just a quickstart guide and does not show the full potential of Kieker. You can find more details in the user guide. If you want to use Kieker from within Eclipse, you might want to take a look into the Eclipse quickstart guide instead. The shown steps are possible since Kieker 1.14 and of course with the nightly build.


  • Download Kieker and copy kieker-1.15-aspectj.jar from the build/libs/ directory into the same directory as your jar file.
  • Execute java -javaagent:kieker-1.15-aspectj.jar -jar MyJar.jar

Kieker writes the monitoring log files into the system’s default temporary directory (e.g. /tmp/) in a directory named kieker-<date>-<timestamp>-UTC. The precise path can be found in the console output.

Alternatively, you can specify the path to the kieker property file kieker.properties and the AspectJ file aop.xml as follows:
java -javaagent:kieker-1.15-aspectj.jar -Dkieker.monitoring.configuration=file://path/to/kieker.properties -Dorg.aspectj.weaver.loadtime.configuration=file://path/to/aop.xml -jar MyJar.jar


Under Linux you should use in the following the corresponding .sh-scripts instead of the .bat-scripts.

  • Install Graphviz and make sure that the binaries are accessible via the system’s path.
  • Execute bin\trace-analysis.bat -i <temporary directory>/kieker-<date>-<timestamp>-UTC -o . --plot-Aggregated-Assembly-Call-Tree --plot-Assembly-Component-Dependency-Graph
  • Execute bin\dotPic-fileConverter.bat . png