2.60. Jolokia
Expose runtime metrics and management operations via JMX with Jolokia
2.60.1. Maven coordinates
Create a new project with this extension on code.camel.redhat.com
Or add the coordinates to your existing project:
<dependency>
<groupId>org.apache.camel.quarkus</groupId>
<artifactId>camel-quarkus-jolokia</artifactId>
</dependency>2.60.2. Usage
This extension adds Jolokia support to your application.
2.60.2.1. Jolokia HTTP endpoints
In prod mode, Jolokia is accessible at the following URLs.
In dev and test modes Jolokia is bound only to localhost.
To disable exposing Jolokia via the Quarkus management interface at /q/jolokia, add the following configuration to application.properties.
quarkus.camel.jolokia.register-management-endpoint=false
If you want to disable Jolokia entirely, then add the following configuration to application.properties.
quarkus.camel.jolokia.enabled=false2.60.2.2. Jolokia configuration
Any of the Jolokia configuration options can be configured via the quarkus.camel.jolokia.additional-properties.<jolokia-property-name> option. Where <jolokia-property-name> is the name of the Jolokia configuration option you want to set.
For example, the following configuration added to application.properties enables Jolokia debugging and sets the max depth for traversing bean properties.
quarkus.camel.jolokia.additional-properties.debug=true
quarkus.camel.jolokia.additional-properties.maxDepth=102.60.2.3. Jolokia restrictor
By default, a Jolokia restrictor is automatically registered that exposes access to only a specific set of MBean domains.
-
org.apache.camel -
java.lang -
java.nio
If this is too restrictive, then you can either specify your own MBean domains, disable the default restrictor, or create a custom restrictor.
2.60.2.3.1. Default restrictor MBean domains
You can modify the set of MBean domains referenced by the default restrictor by adding configuration like the following to application.properties.
quarkus.camel.jolokia.camel-restrictor-allowed-mbean-domains=org.apache.camel2.60.2.3.2. Disabling the default restrictor
The following configuration added to application.properties disables the default restrictor.
quarkus.camel.jolokia.register-camel-restrictor=false2.60.2.3.3. Create a custom restrictor
You can create your own restrictor class and register it with Jolokia.
public class CustomRestrictor extends AllowAllRestrictor {
// Override methods to apply custom restrictions
}
Register the restrictor with Jolokia by adding the following configuration to application.properties.
quarkus.camel.jolokia.additional-properties.restrictorClass=org.acme.CustomRestrictor2.60.2.4. Kubernetes & OpenShift support
2.60.2.4.1. Generated Kubernetes manifests
If the quarkus-kubernetes or quarkus-openshift extensions are present, a container port named jolokia will be added automatically to the pod configuration within the generated Kubernetes manifest resources.
This can be disabled by adding the following configuration to application.properties.
quarkus.camel.jolokia.kubernetes.expose-container-port=false2.60.2.4.2. Automatic enablement of SSL client authentication
If the application detects that it is running on Kubernetes or OpenShift, then Jolokia is automatically configured for SSL client authentication. This is useful if you use tools like Hawtio to discover and connect to your running application pod.
This functionality can be disabled by adding the following configuration to application.properties.
quarkus.camel.jolokia.kubernetes.client-authentication-enabled=falseNote that if you choose to use hawtio-online to connect to your running application, then you must configure the Jolokia client principal.
quarkus.camel.jolokia.kubernetes.client-principal=cn=hawtio-online.hawtio.svc2.60.3. Camel Quarkus limitations
2.60.3.1. Native mode limitations
JMX in GraalVM is still experimental. Therefore, some features are not available in native mode.
Refer to the Camel Quarkus Management extension limitations section for more details.
2.60.4. Additional Camel Quarkus configuration
| Configuration property | Type | Default |
|---|---|---|
|
Enables Jolokia support. |
|
|
|
The context path that the Jolokia agent is deployed under. |
|
|
|
Whether to register a Quarkus management endpoint for Jolokia (default |
|
|
|
Comma separated list of allowed MBean domains used by |
List of |
|
|
When {@code true} and the quarkus-kubernetes extension is present, a container port named jolokia will be added to the generated Kubernetes manifests within the container spec ports definition. |
|
|
|
Whether the Jolokia agent HTTP server should be started automatically. When set to |
|
|
|
The host address to which the Jolokia agent HTTP server should bind to. When unspecified, the default is localhost for dev and test mode. In prod mode the default is to bind to all interfaces at 0.0.0.0. |
| |
|
The port the Jolokia agent HTTP server listens to. |
|
|
|
The mode in which Jolokia agent discovery is enabled. The default |
|
|
|
Whether to enable Jolokia SSL client authentication in Kubernetes environments. Useful for tools such as hawtio to be able to connect with your application. |
|
|
|
Absolute path of the CA certificate Jolokia should use for SSL client authentication. |
| |
|
The principal which must be given in a client certificate to allow access to Jolokia. |
| |
|
Arbitrary Jolokia configuration options. These are described at the Jolokia documentation. Options can be configured like |
| |
|
When
Note that this option has no effect if |
|
|
Configuration property fixed at build time. All other configuration properties are overridable at runtime.
'%20d='M201.5%20305.5c-13.8%200-24.9-11.1-24.9-24.6%200-13.8%2011.1-24.9%2024.9-24.9%2013.6%200%2024.6%2011.1%2024.6%2024.9%200%2013.6-11.1%2024.6-24.6%2024.6zM504%20256c0%20137-111%20248-248%20248S8%20393%208%20256%20119%208%20256%208s248%20111%20248%20248zm-132.3-41.2c-9.4%200-17.7%203.9-23.8%2010-22.4-15.5-52.6-25.5-86.1-26.6l17.4-78.3%2055.4%2012.5c0%2013.6%2011.1%2024.6%2024.6%2024.6%2013.8%200%2024.9-11.3%2024.9-24.9s-11.1-24.9-24.9-24.9c-9.7%200-18%205.8-22.1%2013.8l-61.2-13.6c-3-.8-6.1%201.4-6.9%204.4l-19.1%2086.4c-33.2%201.4-63.1%2011.3-85.5%2026.8-6.1-6.4-14.7-10.2-24.1-10.2-34.9%200-46.3%2046.9-14.4%2062.8-1.1%205-1.7%2010.2-1.7%2015.5%200%2052.6%2059.2%2095.2%20132%2095.2%2073.1%200%20132.3-42.6%20132.3-95.2%200-5.3-.6-10.8-1.9-15.8%2031.3-16%2019.8-62.5-14.9-62.5zM302.8%20331c-18.2%2018.2-76.1%2017.9-93.6%200-2.2-2.2-6.1-2.2-8.3%200-2.5%202.5-2.5%206.4%200%208.6%2022.8%2022.8%2087.3%2022.8%20110.2%200%202.5-2.2%202.5-6.1%200-8.6-2.2-2.2-6.1-2.2-8.3%200zm7.7-75c-13.6%200-24.6%2011.1-24.6%2024.9%200%2013.6%2011.1%2024.6%2024.6%2024.6%2013.8%200%2024.9-11.1%2024.9-24.6%200-13.8-11-24.9-24.9-24.9z'/%3e%3c/svg%3e){kind=small}