This Confluence has been LDAP enabled, if you are an ASF Committer, please use your LDAP Credentials to login. Any problems file an INFRA jira ticket please.

Child pages
  • Camel JMX
Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 6 Next »

Camel JMX

Apache Camel has extensive support for JMX to allow you to monitor and control the behavior of the broker via the JMX MBeans.

Using JMX to monitor Apache Camel

You can enable/disable JMX support as follows...

1. Run a camel context setting the context property useJmx to true.

  <camelContext id="camel" useJmx="true" xmlns="">    

2. Run a JMX console (e.g. jconsole - JMX console included in the JDK <JAVA_HOME>/bin/jconsole.exe)

3. Connect to the given JMX URL:

The CamelContext should appear in the list of local connections, if you are running JConsole on the same host as Camel.

To connect to a remote Camel instance, or if the local process does not show up, use Remote Process option, and enter an URL. Here is an example localhost URL:


Using the Apache Camel which Jconsole


The SystemProperties for Camel JMX support

Property Name




true or false

if is true , it will enable jmx feature in Camel


true or false

if is true, Camel JMX agent will use the platformMBeanServer which holds the JVM's memory, cpu and some other management information

Advanced JMX Configuration

The spring configuration file allows you to configure how Camel is exposed to JMX for management. In some cases, you could specify more information here, like the connector's port or the path name.


<camelContext id="camel" useJmx="true" xmlns="">
    <jmxAgent id="agent" connectorPort="20008" jmxDomainName="org.apache.camel.test"/>
      <from uri="seda:start"/>
      <to uri="mock:result"/>

If you wish to change the Java 5 JMX settings you can use various JMX system properties

For example you can enable remote JMX connections to the Sun JMX connector, via setting the following environment variable (using set or export depending on your platform). These settings only configure the Sun JMX connector within Java 1.5+, not the JMX connector that Camel creates by default. \

(The SUNJMX environment variable is simple used by the startup script for Camel, as additional startup parameters for the JVM. If you start Camel directly, you'll have to pass these parameters yourself.)

jmxAgent Properties Reference

Property Name

Default Value




The JMX agent name, and it is not optional



If true then it will use the plateform MBean server form the JVM



The jmx domain that all objects names will use



If we should create a JMX connector (to allow remote management) for the MBeanServer



The port that the JMX connector will use



The path that JMX connector will be registered under

  • No labels