Versions Compared


  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrated to Confluence 5.3

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.

You should have a Ganglia gmond agent running on the machine where your JVM runs.  The gmond sends a heartbeat to the Ganglia infrastructure, camel-ganglia can't send the heartbeat itself currently.

On most Linux systems (Debian, Ubuntu, Fedora and RHEL/CentOS with EPEL) you can just install the Ganglia agent package and it runs automatically using multicast configuration.  You can configure it to use regular UDP unicast if you prefer.

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


Code Block
    <!-- use the same version as your Camel core version -->

URI format

Code Block

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

Ganglia component and endpoint URI options

NameDefault valueDescriptionOverride with header
modeMULTICASTSend the UDP metric packets using MULTICAST or UNICAST 
ttl5If using multicast, set the TTL of the packets 
wireFormat31xtrueUse the wire format of Ganglia 3.1.0 and later versions.  Set this to false to use Ganglia 3.0.x or earlier. 
groupNameJavaThe group that the metric belongs to. 
prefix (optional) Prefix the metric name with this string and an underscore. 
metricNamemetricThe name to use for the metric.GangliaConstants.METRIC_NAME
typeSTRINGThe type of value, see GMetricType javadoc for permitted values. (Confluence not allowing the link)GangliaConstants.METRIC_TYPE
slopeBOTHThe 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
tmax60Maximum time in seconds that the value can be considered current.  After this, Ganglia considers the value to have expired.GangliaConstants.METRIC_TMAX
dmax0Minumum 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.


Sending a String metric

The message body will be converted to a String and sent as a metric value.  Unlike numeric metrics, String values can't be charted but Ganglia makes them available for reporting.  The os_version string at the top of every Ganglia host page is an example of a String metric.

Code Block
    .setHeader(GangliaConstants.METRIC_NAME, simple("my_string_metric"))
    .setHeader(GangliaConstants.METRIC_TYPE, GMetricType.STRING)


Sending a numeric metric

Code Block
    .setHeader(GangliaConstants.METRIC_NAME, simple("widgets_in_stock"))
    .setHeader(GangliaConstants.METRIC_TYPE, GMetricType.UINT32)
    .setHeader(GangliaConstants.METRIC_UNITS, simple("widgets"))