Author: buildbot
Date: Fri Feb 20 10:18:26 2015
New Revision: 940838
Log:
Production update by buildbot for camel
Modified:
websites/production/camel/content/cache/main.pageCache
websites/production/camel/content/ganglia.html
Modified: websites/production/camel/content/cache/main.pageCache
==============================================================================
Binary files - no diff available.
Modified: websites/production/camel/content/ganglia.html
==============================================================================
--- websites/production/camel/content/ganglia.html (original)
+++ websites/production/camel/content/ganglia.html Fri Feb 20 10:18:26 2015
@@ -85,7 +85,7 @@
<tbody>
<tr>
<td valign="top" width="100%">
-<div class="wiki-content maincontent"><h2
id="Ganglia-Gangliacomponent">Ganglia component</h2><h4
id="Ganglia-AvailableasofCamel2.15.0">Available as of Camel
2.15.0</h4><p>Provides a mechanism to send a value (the message body) as a
metric to the <a shape="rect" class="external-link" href="http://ganglia.info";
rel="nofollow">Ganglia</a> monitoring system.  Uses the gmetric4j
library.  Can be used in conjunction with standard <a shape="rect"
class="external-link" href="http://ganglia.info"; rel="nofollow">Ganglia</a> and
<a shape="rect" class="external-link"
href="https://github.com/ganglia/jmxetric"; rel="nofollow">JMXetric</a> for
monitoring metrics from the OS, JVM and business processes through a single
platform.</p><p>Maven users will need to add the following dependency to their
<code>pom.xml</code> for this component:</p><div class="container" title="Hint:
double-click to select code"><p> </p><div class="code panel pdl"
style="border-width: 1px;"><div class="codeC
ontent panelContent pdl">
+<div class="wiki-content maincontent"><h2
id="Ganglia-Gangliacomponent">Ganglia component</h2><h4
id="Ganglia-AvailableasofCamel2.15.0">Available as of Camel
2.15.0</h4><p>Provides a mechanism to send a value (the message body) as a
metric to the <a shape="rect" class="external-link" href="http://ganglia.info";
rel="nofollow">Ganglia</a> monitoring system.  Uses the gmetric4j
library.  Can be used in conjunction with standard <a shape="rect"
class="external-link" href="http://ganglia.info"; rel="nofollow">Ganglia</a> and
<a shape="rect" class="external-link"
href="https://github.com/ganglia/jmxetric"; rel="nofollow">JMXetric</a> for
monitoring metrics from the OS, JVM and business processes through a single
platform.</p><p>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.</p><p>On most Linux systems (Debian, Ubuntu, Fedora a
nd 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.</p><p>Maven users will need to add
the following dependency to their <code>pom.xml</code> for this
component:</p><div class="container" title="Hint: double-click to select
code"><p> </p><div class="code panel pdl" style="border-width: 1px;"><div
class="codeContent panelContent pdl">
<script class="theme: Default; brush: xml; gutter: false"
type="syntaxhighlighter"><![CDATA[<dependency>
<groupId>org.apache.camel</groupId>
<artifactId>camel-ganglia</artifactId>
@@ -94,7 +94,24 @@
</dependency>]]></script>
</div></div><h2 id="Ganglia-URIformat">URI format</h2><div class="code panel
pdl" style="border-width: 1px;"><div class="codeContent panelContent pdl">
<script class="theme: Default; brush: java; gutter: false"
type="syntaxhighlighter"><![CDATA[ganglia:address:port[?options]]]></script>
-</div></div><p class="line number1 index0 alt2">You can append query options
to the URI in the following format,
<code>?option=value&option=value&...</code></p><h2 class="line number1
index0 alt2" id="Ganglia-GangliacomponentandendpointURIoptions">Ganglia
component and endpoint URI options</h2><div class="table-wrap"><table
class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1"
class="confluenceTh">Name</th><th colspan="1" rowspan="1"
class="confluenceTh">Default value</th><th colspan="1" rowspan="1"
class="confluenceTh">Description</th><th colspan="1" rowspan="1"
class="confluenceTh">Override with header</th></tr><tr><td colspan="1"
rowspan="1" class="confluenceTd">mode</td><td colspan="1" rowspan="1"
class="confluenceTd">MULTICAST</td><td colspan="1" rowspan="1"
class="confluenceTd">Send the UDP metric packets using MULTICAST or
UNICAST</td><td colspan="1" rowspan="1"
class="confluenceTd"> </td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd">ttl</td>
<td colspan="1" rowspan="1" class="confluenceTd">5</td><td colspan="1"
rowspan="1" class="confluenceTd">If using multicast, set the TTL of the
packets</td><td colspan="1" rowspan="1"
class="confluenceTd"> </td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd">wireFormat31x</td><td colspan="1" rowspan="1"
class="confluenceTd">true</td><td colspan="1" rowspan="1"
class="confluenceTd">Use the wire format of Ganglia 3.1.0 and later
versions.  Set this to false to use Ganglia 3.0.x or earlier.</td><td
colspan="1" rowspan="1" class="confluenceTd"> </td></tr><tr><td
colspan="1" rowspan="1" class="confluenceTd">groupName</td><td colspan="1"
rowspan="1" class="confluenceTd">Java</td><td colspan="1" rowspan="1"
class="confluenceTd">The group that the metric belongs to.</td><td colspan="1"
rowspan="1" class="confluenceTd"> </td></tr><tr><td colspan="1"
rowspan="1" class="confluenceTd">prefix</td><td colspan="1" rowspan="1"
class="confluenceTd"> </td><td colspan
="1" rowspan="1" class="confluenceTd">(optional) Prefix the metric name with
this string and an underscore.</td><td colspan="1" rowspan="1"
class="confluenceTd"> </td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd">metricName</td><td colspan="1" rowspan="1"
class="confluenceTd">metric</td><td colspan="1" rowspan="1"
class="confluenceTd">The name to use for the metric.</td><td colspan="1"
rowspan="1" class="confluenceTd">GangliaConstants.METRIC_NAME</td></tr><tr><td
colspan="1" rowspan="1" class="confluenceTd">type</td><td colspan="1"
rowspan="1" class="confluenceTd">STRING</td><td colspan="1" rowspan="1"
class="confluenceTd">The type of value, see GMetricType javadoc for permitted
values. (Confluence not allowing the link)</td><td colspan="1" rowspan="1"
class="confluenceTd">GangliaConstants.METRIC_TYPE</td></tr><tr><td colspan="1"
rowspan="1" class="confluenceTd">slope</td><td colspan="1" rowspan="1"
class="confluenceTd">BOTH</td><td colspan="1" rowspan="1" class="co
nfluenceTd">The slope, see GMetricSlope javadoc for permitted values.
(Confluence not allowing the link)</td><td colspan="1" rowspan="1"
class="confluenceTd"><code class="xml
plain">GangliaConstants.METRIC_</code>SLOPE</td></tr><tr><td colspan="1"
rowspan="1" class="confluenceTd">units</td><td colspan="1" rowspan="1"
class="confluenceTd"> </td><td colspan="1" rowspan="1"
class="confluenceTd">(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.</td><td colspan="1" rowspan="1" class="confluenceTd"><code
class="xml plain">GangliaConstants.METRIC_UNITS</code></td></tr><tr><td
colspan="1" rowspan="1" class="confluenceTd">tmax</td><td colspan="1"
rowspan="1" class="confluenceTd">60</td><td colspan="1" rowspan="1"
class="confluenceTd">Maximum time in seconds that the value can be considered
current.  After th
is, Ganglia considers the value to have expired.</td><td colspan="1"
rowspan="1" class="confluenceTd"><code class="xml
plain">GangliaConstants.METRIC_</code>TMAX</td></tr><tr><td colspan="1"
rowspan="1" class="confluenceTd">dmax</td><td colspan="1" rowspan="1"
class="confluenceTd">0</td><td colspan="1" rowspan="1"
class="confluenceTd">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.</td><td colspan="1" rowspan="1"
class="confluenceTd"><code class="xml
plain">GangliaConstants.METRIC_</code>DMAX</td></tr></tbody></table></div><h2
id="Ganglia-Messagebody">Message body</h2><p>Any value (such as a string or
numeric type) in the body is sent to the Ganglia system.</p><h2
id="Ganglia-Returnvalue/response">Return value / response</h2><p>Ganglia sends
metrics using unidirectional UDP or multicast.  There is no response or
change to the message body.</p></div></d
iv>
+</div></div><p class="line number1 index0 alt2">You can append query options
to the URI in the following format,
<code>?option=value&option=value&...</code></p><h2 class="line number1
index0 alt2" id="Ganglia-GangliacomponentandendpointURIoptions">Ganglia
component and endpoint URI options</h2><div class="table-wrap"><table
class="confluenceTable"><tbody><tr><th colspan="1" rowspan="1"
class="confluenceTh">Name</th><th colspan="1" rowspan="1"
class="confluenceTh">Default value</th><th colspan="1" rowspan="1"
class="confluenceTh">Description</th><th colspan="1" rowspan="1"
class="confluenceTh">Override with header</th></tr><tr><td colspan="1"
rowspan="1" class="confluenceTd">mode</td><td colspan="1" rowspan="1"
class="confluenceTd">MULTICAST</td><td colspan="1" rowspan="1"
class="confluenceTd">Send the UDP metric packets using MULTICAST or
UNICAST</td><td colspan="1" rowspan="1"
class="confluenceTd"> </td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd">ttl</td>
<td colspan="1" rowspan="1" class="confluenceTd">5</td><td colspan="1"
rowspan="1" class="confluenceTd">If using multicast, set the TTL of the
packets</td><td colspan="1" rowspan="1"
class="confluenceTd"> </td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd">wireFormat31x</td><td colspan="1" rowspan="1"
class="confluenceTd">true</td><td colspan="1" rowspan="1"
class="confluenceTd">Use the wire format of Ganglia 3.1.0 and later
versions.  Set this to false to use Ganglia 3.0.x or earlier.</td><td
colspan="1" rowspan="1" class="confluenceTd"> </td></tr><tr><td
colspan="1" rowspan="1" class="confluenceTd">groupName</td><td colspan="1"
rowspan="1" class="confluenceTd">Java</td><td colspan="1" rowspan="1"
class="confluenceTd">The group that the metric belongs to.</td><td colspan="1"
rowspan="1" class="confluenceTd"> </td></tr><tr><td colspan="1"
rowspan="1" class="confluenceTd">prefix</td><td colspan="1" rowspan="1"
class="confluenceTd"> </td><td colspan
="1" rowspan="1" class="confluenceTd">(optional) Prefix the metric name with
this string and an underscore.</td><td colspan="1" rowspan="1"
class="confluenceTd"> </td></tr><tr><td colspan="1" rowspan="1"
class="confluenceTd">metricName</td><td colspan="1" rowspan="1"
class="confluenceTd">metric</td><td colspan="1" rowspan="1"
class="confluenceTd">The name to use for the metric.</td><td colspan="1"
rowspan="1" class="confluenceTd">GangliaConstants.METRIC_NAME</td></tr><tr><td
colspan="1" rowspan="1" class="confluenceTd">type</td><td colspan="1"
rowspan="1" class="confluenceTd">STRING</td><td colspan="1" rowspan="1"
class="confluenceTd">The type of value, see GMetricType javadoc for permitted
values. (Confluence not allowing the link)</td><td colspan="1" rowspan="1"
class="confluenceTd">GangliaConstants.METRIC_TYPE</td></tr><tr><td colspan="1"
rowspan="1" class="confluenceTd">slope</td><td colspan="1" rowspan="1"
class="confluenceTd">BOTH</td><td colspan="1" rowspan="1" class="co
nfluenceTd">The slope, see GMetricSlope javadoc for permitted values.
(Confluence not allowing the link)</td><td colspan="1" rowspan="1"
class="confluenceTd"><code class="xml
plain">GangliaConstants.METRIC_</code>SLOPE</td></tr><tr><td colspan="1"
rowspan="1" class="confluenceTd">units</td><td colspan="1" rowspan="1"
class="confluenceTd"> </td><td colspan="1" rowspan="1"
class="confluenceTd">(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.</td><td colspan="1" rowspan="1" class="confluenceTd"><code
class="xml plain">GangliaConstants.METRIC_UNITS</code></td></tr><tr><td
colspan="1" rowspan="1" class="confluenceTd">tmax</td><td colspan="1"
rowspan="1" class="confluenceTd">60</td><td colspan="1" rowspan="1"
class="confluenceTd">Maximum time in seconds that the value can be considered
current.  After th
is, Ganglia considers the value to have expired.</td><td colspan="1"
rowspan="1" class="confluenceTd"><code class="xml
plain">GangliaConstants.METRIC_</code>TMAX</td></tr><tr><td colspan="1"
rowspan="1" class="confluenceTd">dmax</td><td colspan="1" rowspan="1"
class="confluenceTd">0</td><td colspan="1" rowspan="1"
class="confluenceTd">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.</td><td colspan="1" rowspan="1"
class="confluenceTd"><code class="xml
plain">GangliaConstants.METRIC_</code>DMAX</td></tr></tbody></table></div><h2
id="Ganglia-Messagebody">Message body</h2><p>Any value (such as a string or
numeric type) in the body is sent to the Ganglia system.</p><h2
id="Ganglia-Returnvalue/response">Return value / response</h2><p>Ganglia sends
metrics using unidirectional UDP or multicast.  There is no response or
change to the message body.</p><h2 id="G
anglia-Examples">Examples</h2><h3 id="Ganglia-SendingaStringmetric">Sending a
String metric</h3><p>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.</p><div
class="code panel pdl" style="border-width: 1px;"><div class="codeContent
panelContent pdl">
+<script class="theme: Default; brush: java; gutter: false"
type="syntaxhighlighter"><![CDATA[from("direct:string.for.ganglia")
+ .setHeader(GangliaConstants.METRIC_NAME,
simple("my_string_metric"))
+ .setHeader(GangliaConstants.METRIC_TYPE, GMetricType.STRING)
+ .to("direct:ganglia.tx");
+
+from("direct:ganglia.tx")
+
.to("ganglia:239.2.11.71:8649?mode=MULTICAST&prefix=test");]]></script>
+</div></div><h3 id="Ganglia-Sendinganumericmetric">Sending a numeric
metric</h3><div class="code panel pdl" style="border-width: 1px;"><div
class="codeContent panelContent pdl">
+<script class="theme: Default; brush: java; gutter: false"
type="syntaxhighlighter"><![CDATA[from("direct:value.for.ganglia")
+ .setHeader(GangliaConstants.METRIC_NAME,
simple("widgets_in_stock"))
+ .setHeader(GangliaConstants.METRIC_TYPE, GMetricType.UINT32)
+ .setHeader(GangliaConstants.METRIC_UNITS, simple("widgets"))
+ .to("direct:ganglia.tx");
+
+from("direct:ganglia.tx")
+
.to("ganglia:239.2.11.71:8649?mode=MULTICAST&prefix=test");]]></script>
+</div></div></div></div>
</td>
<td valign="top">
<div class="navigation">
