inspectIT Ocelot Plugins

OpenCensus comes with a wide range of exporter which we cannot all include in our Java Agent inspectIT Ocelot. For this reason you can use plugins to add any OpenCensus Metrics or Trace exporter you want to Ocelot.

See the Documentation on how to configure your Agent to load your plugins. For building the plugin JAR files see the instructions below.

Building the Plugins

The plugins depend on two projects of inspectIT Ocelot: The inspectit-ocelot-sdk and the inspectit-ocelot-config project. As we do not push these yet to the Maven Central repository, you need to build them locally and add them to your local maven repository. To do so, clone the Ocelot Repository and simply run the following command in its root directory:

./gradlew :inspectit-ocelot-config:install
./gradlew :inspectit-ocelot-sdk:install

Afterwards you're able to build the plugins contained in this repository.

In order to do this, cd into the project directory you would like to build and run:

./gradlew jar

The built JAR will be located in the /build/libs folder and is ready to be used as a plugin for the inspectIT Ocelot Java agent.

Custom Plugins

When developing custom plugins they need to implement the ConfigurablePlugin Interface and have the @OcelotPlugin annotation in order to be loaded by the agent.

@OcelotPlugin(value = "pluginName", defaultConfig = "default.yml")

The plugin name will resolve to the name used for configuring the plugin.

Additionally, plugins should overwrite the functions handed down by the interface. The start and update function will be called upon loading the plugin for the first time or whenever the plugin configuration changes.

Details on how to attach plugins to an inspectIT Ocelot agent or how plugins can be configured can be found within the documentation.