Development Guidelines

Owned by Andre van Hoorn
Last updated: Sept 12, 2017 by Reiner Jung

Naming Conventions within the Kieker Project

We defined in KIEKER-1407 some basic rules how packages should be named within the Kieker project and how to come up with new suitable names within the realm of Kieker. This applies to all tools using Kieker or providing tooling for Kieker.

Java rules

  • kieker.tools.${TOOL_PACKAGE_NAME} for tools who built upon Kieker, like the analysis tool, the Kieker diagnosis tool, etc.
  • kieker.develop.${TOOL_PACKAGE_NAME} for kieker development tools, like the IRL, IAL and other tools which support a developer applying Kieker to their software
  • kieker.monitoring.* for everything regarding the monitoring
  • kieker.common.* for everything shared between monitoring and analysis
  • kieker.analysis.* for analysis filters and functionality which is part of the framework.

C and C++ rules

C does not have a package structure. However, the conventions are to follow the associated directory scheme from Java. That implies, source is located in src/kieker/* and function names are prefixed accordingly. That is kieker_tools_*, kieker_develop_* etc.

Other language rules

The naming conventions for other languages follow a similar scheme than those for Java.