jolokia/java-jolokia repository overview

⁠Java Image with Jolokia

This image is based on the official java⁠ image and includes a Jolokia JVM agent. The agent is installed as /opt/jolokia/jolokia.jar.

In order to enable Jolokia for your application you should use this image as a base image (via FROM) and use the output of jolokia_opts in your startup scripts to include it in your startup options.

For example, the following snippet can be added to a script starting up your Java application

# ...
export JAVA_OPTIONS="$JAVA_OPTIONS $(jolokia_opts)"
# .... us JAVA_OPTIONS when starting your app, e.g. as Tomcat does

You can influence the behaviour jolokia_opts by setting various environment variables:

• JOLOKIA_OFF : If set disables activation of Jolokia (i.e. echos an empty value). By default, Jolokia is enabled.
• JOLOKIA_CONFIG : If set uses this file (including path) as Jolokia JVM agent properties (as described in Jolokia's reference manual⁠). By default this is /opt/jolokia/jolokia.properties. If this file exists, it be will taken as configuration and any other config options are ignored.
• JOLOKIA_HOST : Host address to bind to (Default: 0.0.0.0)
• JOLOKIA_PORT : Port to use (Default: 8778)
• JOLOKIA_USER : User for authentication. By default authentication is switched off.
• JOLOKIA_PASSWORD : Password for authentication. By default authentication is switched off.
• JOLOKIA_ID : Agent ID to use ($HOSTNAME by default, which is the container id)
• JOLOKIA_OPTS : Additional options to be appended to the agent opts. They should be given in the format "key=value,key=value,..."

Some options for integration in various environments

• JOLOKIA_AUTH_OPENSHIFT : Switch on OAuth2 authentication for OpenShift. The value of this parameter must be the OpenShift API's base URL (e.g. https://localhost:8443/osapi/v1beta3/)

So, if you start the container with docker run -e JOLOKIA_OFF ... no agent will be launched.

The following versions are used:

• Java Version: OpenJDK 1.6.0_35 (6b35-1.13.7-1~deb7u1) (base image: java:6b35)
• Jolokia Version: 1.3.1
• Jolokia Port: 8778