Ganglia

Ganglia component

Available as of Camel 2.15.0

Provides a mechanism to send a value (the message body) as a metric to the Ganglia monitoring system. Uses the gmetric4j library. Can be used in conjunction with standard Ganglia and JMXetric for monitoring metrics from the OS, JVM and business processes through a single platform.

Maven users will need to add the following dependency to their pom.xml for this component:

<dependency>
    <groupId>org.apache.camel</groupId>
    <artifactId>camel-ganglia</artifactId>
    <version>x.x.x</version>
    <!-- use the same version as your Camel core version -->
</dependency>

URI format

ganglia:address:port[?options]

You can append query options to the URI in the following format, ?option=value&option=value&...

Ganglia component and endpoint URI options

Name	Default value	Description	Override with header
mode	MULTICAST	Send the UDP metric packets using MULTICAST or UNICAST
ttl	5	If using multicast, set the TTL of the packets
wireFormat31x	true	Use the wire format of Ganglia 3.1.0 and later versions. Set this to false to use Ganglia 3.0.x or earlier.
groupName	Java	The group that the metric belongs to.
prefix		(optional) Prefix the metric name with this string and an underscore.
metricName	metric	The name to use for the metric.	GangliaConstants.METRIC_NAME
type	STRING	The type of value, see GMetricType javadoc for permitted values. (Confluence not allowing the link)	GangliaConstants.METRIC_TYPE
slope	BOTH	The slope, see GMetricSlope javadoc for permitted values. (Confluence not allowing the link)	`GangliaConstants.METRIC_`SLOPE
units		(optional) Any unit of measurement that qualifies the metric, e.g. widgets, litres, bytes. Do not include a prefix such as k (kilo) or m (milli), other tools may scale the units later. The value should be unscaled.	`GangliaConstants.METRIC_UNITS`
tmax	60	Maximum time in seconds that the value can be considered current. After this, Ganglia considers the value to have expired.	`GangliaConstants.METRIC_`TMAX
dmax	0	Minumum time in seconds before Ganglia will purge the metric value if it expires. Set to 0 and the value will remain in Ganglia indefinitely until a gmond agent restart.	`GangliaConstants.METRIC_`DMAX

Message body

Any value (such as a string or numeric type) in the body is sent to the Ganglia system.

Return value / response

Ganglia sends metrics using unidirectional UDP or multicast. There is no response or change to the message body.

Child pages