Graphite Telemetry
The Graphite telemetry adapter lets you push telemetry data over UDP to Meridian using the plaintext protocol.
To enable support for plaintext Graphite over UDP, edit $OPENNMS_HOME/etc/telemetryd-configuration.xml
to set enabled=true
for the Graphite protocol.
<listener name="Graphite-UDP-2003" class-name="org.opennms.netmgt.telemetry.listeners.UdpListener" enabled="true">
<parameter key="port" value="2003"/>
<parser name="Graphite-Parser" class-name="org.opennms.netmgt.telemetry.protocols.common.parser.ForwardParser" queue="Graphite" />
</listener>
<queue name="Graphite">
<adapter name="Graphite" class-name="org.opennms.netmgt.telemetry.protocols.graphite.adapter.GraphiteAdapter" enabled="true">
<parameter key="script" value="$OPENNMS_HOME/etc/telemetryd-adapters/graphite-telemetry-interface.groovy"/>
<package name="Graphite-Default">
<rrd step="300">
<rra>RRA:AVERAGE:0.5:1:2016</rra>
<rra>RRA:AVERAGE:0.5:12:1488</rra>
<rra>RRA:AVERAGE:0.5:288:366</rra>
<rra>RRA:MAX:0.5:288:366</rra>
<rra>RRA:MIN:0.5:288:366</rra>
</rrd>
</package>
</adapter>
</queue>
Apply the changes without restarting by sending a reloadDaemonConfig
event in the CLI or the Web UI:
$OPENNMS_HOME/bin/send-event.pl -p 'daemonName Telemetryd' uei.opennms.org/internal/reloadDaemonConfig
By default, this opens a UDP socket bound to 0.0.0.0:2003
to which Graphite messages can be forwarded.
Configure Graphite listener on a Minion
To enable and configure a UDP Listener for Graphite on Minion, connect to the Karaf Console and set the following properties:
$ ssh -p 8201 admin@localhost
...
admin@minion()> config:edit --alias udp-2003 --factory org.opennms.features.telemetry.listeners
admin@minion()> config:property-set name Graphite
admin@minion()> config:property-set class-name org.opennms.netmgt.telemetry.listeners.UdpListener
admin@minion()> config:property-set parameters.port 2003
admin@minion()> config:property-set parsers.0.name Graphite
admin@minion()> config:property-set parsers.0.class-name org.opennms.netmgt.telemetry.protocols.common.parser.ForwardParser
admin@minion()> config:update
The protocol must also be enabled on Meridian for the messages to be processed. |
Graphite adapter
The Graphite adapter handles Graphite payloads. Messages are decoded and forwarded to a JSR-223-compatible script (for example, Beanshell or Groovy) for further processing. Using the script extension you can extract the desired metrics from the Graphite messages and persist the results as time series data.
Configuration and use
Parameter | Description | Default |
---|---|---|
script |
Full path to the script used to handle the Graphite messages. |
none |
Scripting
The script is invoked for every Graphite message that is received and successfully decoded.
The following globals will be passed to the script:
Parameter | Description | Type |
---|---|---|
agent |
The agent (node) against which the metrics will be associated. |
org.opennms.netmgt.collection.api.CollectionAgent |
builder |
Builder in which the resources and metrics should be added. |
org.opennms.netmgt.collection.support.builder.CollectionSetBuilder |
msg |
Decoded message from which the metrics should be extracted. |
org.opennms.netmgt.telemetry.protocols.graphite.adapter.GraphiteMetric |