JMX

Receive JMX notifications.

Metadata

Property	Value
Scheme	`jmx`
Support Level	Stable
Labels	monitoring
Version	4.10.2

Maven Dependency

<dependency>
    <groupId>org.apache.camel</groupId>
    <artifactId>camel-jmx</artifactId>
    <version>4.10.2</version>
</dependency>

Endpoint Properties

Name	Type	Required	Default	Description
`serverURL`	string			Server url comes from the remaining endpoint. Use platform to connect to local JVM.
`format`	string		`xml`	Format for the message body. Either xml or raw. If xml, the notification is serialized to xml. If raw, then the raw java object is set as the body.
`granularityPeriod`	duration		`10000`	The frequency to poll the bean to check the monitor (monitor types only).
`monitorType`	string			The type of monitor to create. One of string, gauge, counter (monitor types only).
`objectDomain`	string	✓		The domain for the mbean you're connecting to
`objectName`	string			The name key for the mbean you're connecting to. This value is mutually exclusive with the object properties that get passed.
`observedAttribute`	string			The attribute to observe for the monitor bean or consumer.
`bridgeErrorHandler`	boolean		`false`	Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions (if possible) occurred while the Camel consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. Important: This is only possible if the 3rd party component allows Camel to be alerted if an exception was thrown. Some components handle this internally only, and therefore bridgeErrorHandler is not possible. In other situations we may improve the Camel component to hook into the 3rd party component and make this possible for future releases. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions, that will be logged at WARN or ERROR level and ignored.
`exceptionHandler`	object			To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this option is not in use. By default the consumer will deal with exceptions, that will be logged at WARN or ERROR level and ignored.
`exchangePattern`	object			Sets the exchange pattern when the consumer creates an exchange.
`executorService`	object			To use a custom shared thread pool for the consumers. By default each consume has their own thread-pool to process and route notifications.
`handback`	object			Value to handback to the listener when a notification is received. This value will be put in the message header with the key JMXConstants#JMX_HANDBACK.
`notificationFilter`	object			Reference to a bean that implements the NotificationFilter.
`objectProperties`	object			Properties for the object name. These values will be used if the objectName param is not set
`reconnectDelay`	integer		`10`	The number of seconds to wait before attempting to retry establishment of the initial connection or attempt to reconnect a lost connection
`reconnectOnConnectionFailure`	boolean		`false`	If true the consumer will attempt to reconnect to the JMX server when any connection failure occurs. The consumer will attempt to re-establish the JMX connection every 'x' seconds until the connection is made-- where 'x' is the configured reconnectionDelay
`testConnectionOnStartup`	boolean		`true`	If true the consumer will throw an exception if unable to establish the JMX connection upon startup. If false, the consumer will attempt to establish the JMX connection every 'x' seconds until the connection is made -- where 'x' is the configured reconnectionDelay
`initThreshold`	integer			Initial threshold for the monitor. The value must exceed this before notifications are fired (counter monitor only).
`modulus`	integer			The value at which the counter is reset to zero (counter monitor only).
`offset`	integer			The amount to increment the threshold after it's been exceeded (counter monitor only).
`differenceMode`	boolean		`false`	If true, then the value reported in the notification is the difference from the threshold as opposed to the value itself (counter and gauge monitor only).
`notifyHigh`	boolean		`false`	If true, the gauge will fire a notification when the high threshold is exceeded (gauge monitor only).
`notifyLow`	boolean		`false`	If true, the gauge will fire a notification when the low threshold is exceeded (gauge monitor only).
`thresholdHigh`	number			Value for the gauge's high threshold (gauge monitor only).
`thresholdLow`	number			Value for the gauge's low threshold (gauge monitor only).
`password`	string			Credentials for making a remote connection
`user`	string			Credentials for making a remote connection
`notifyDiffer`	boolean		`false`	If true, will fire a notification when the string attribute differs from the string to compare (string monitor or consumer). By default the consumer will notify match if observed attribute and string to compare has been configured.
`notifyMatch`	boolean		`false`	If true, will fire a notification when the string attribute matches the string to compare (string monitor or consumer). By default the consumer will notify match if observed attribute and string to compare has been configured.
`stringToCompare`	string			Value for attribute to compare (string monitor or consumer). By default the consumer will notify match if observed attribute and string to compare has been configured.