JarCasting
JarCasting JarCasting

jmx2munin

Munin plugin to access JMX information

License

License
GroupId

GroupId

org.vafer
ArtifactId

ArtifactId

jmx2munin
Last Version

Last Version

1.0
Release Date

Release Date
Type

Type

jar
Description

Description

jmx2munin
Munin plugin to access JMX information
Project URL

Project URL

http://github.com/tcurdt/jmx2munin
Source Code Management

Source Code Management

http://github.com/tcurdt/jmx2munin/tree/master

Download jmx2munin

Filename Size
jmx2munin-1.0.pom
jmx2munin-1.0.jar 48 KB
jmx2munin-1.0-sources.jar 6 KB
jmx2munin-1.0-javadoc.jar 66 KB
Browse

How to add to project

<!-- https://jarcasting.com/artifacts/org.vafer/jmx2munin/ -->
<dependency>
    <groupId>org.vafer</groupId>
    <artifactId>jmx2munin</artifactId>
    <version>1.0</version>
</dependency>
// https://jarcasting.com/artifacts/org.vafer/jmx2munin/
implementation 'org.vafer:jmx2munin:1.0'
// https://jarcasting.com/artifacts/org.vafer/jmx2munin/
implementation ("org.vafer:jmx2munin:1.0")
'org.vafer:jmx2munin:jar:1.0'
<dependency org="org.vafer" name="jmx2munin" rev="1.0">
  <artifact name="jmx2munin" type="jar" />
</dependency>
@Grapes(
@Grab(group='org.vafer', module='jmx2munin', version='1.0')
)
libraryDependencies += "org.vafer" % "jmx2munin" % "1.0"
[org.vafer/jmx2munin "1.0"]

Dependencies

compile (1)

Group / Artifact Type Version
com.beust : jcommander jar 1.17

test (1)

Group / Artifact Type Version
junit : junit jar 4.5

Project Modules

There are no modules declared in this project.

jmx2munin

The jmx2munin project exposes JMX MBean attributes to Munin. Some of it's features:

  • strictly complies to the plugin format
  • exposes composite types like Lists, Maps, Set as useful as possible
  • String values can be mapped to numbers

How to use

This is what the Munin script will call. So you should test this first. Of course with your parameters. This example expose all Cassandra information to Munin.

java -jar jmx2munin.jar \
     -url service:jmx:rmi:///jndi/rmi://localhost:7199/jmxrmi \
     -query "org.apache.cassandra.*:*"

The "url" parameters specifies the JMX URL, the query selects the MBeans (and optionally also the attributes) to expose.

java -jar jmx2munin.jar \
     -url service:jmx:rmi:///jndi/rmi://localhost:7199/jmxrmi \
     -query "org.apache.cassandra.*:*" \
     -attribute org_apache_cassandra_db_storageservice_livenodes_size

The script that does the actual interaction with munin you can find in the contrib section. It's the one you should link in the your Munin plugin directory.

:/etc/munin/plugins$ ls -la cassandra_*
lrwxrwxrwx 1 root root 37 2011-04-07 19:58 cassandra_nodes_in_cluster -> /usr/share/munin/plugins/jmx2munin.sh

In the plugin conf you point to the correct configuration

[cassandra_*]
env.url service:jmx:rmi:///jndi/rmi://127.0.0.1:7199/jmxrmi
env.query org.apache.cassandra.*:*

[cassandra_nodes_in_cluster]
env.config cassandra/nodes_in_cluster

A possible configuration could look like this

graph_title Number of Nodes in Cluster
graph_vlabel org_apache_cassandra_db_storageservice_livenodes_size
org_apache_cassandra_db_storageservice_livenodes_size.label number of nodes

The script will extract the attributes from the config and caches the JMX results to reduce the load when showing many values. For testing you can run it manually just like munin would.

MUNIN_LIBDIR='/usr/share/munin'
config='cassandra/nodes_in_cluster'
query='org.apache.cassandra.*:*'
/usr/share/munin/plugins/jmx2munin.sh

More advanced

Sometimes it can be useful to track String values by mapping them into an enum as they really describe states. To find this possible candidates you can call:

java -jar jmx2munin.jar \
     -url service:jmx:rmi:///jndi/rmi://localhost:7199/jmxrmi \
     -query "org.apache.cassandra.*:*" \
     -list

It should output a list of possible candidates. This can now be turned into a enum configuration file:

[org.apache.cassandra.db.StorageService:OperationMode]
0 = ^Normal
1 = ^Client
2 = ^Joining
3 = ^Bootstrapping
4 = ^Leaving
5 = ^Decommissioned
6 = ^Starting drain
7 = ^Node is drained

Which you then can provide:

java -jar jmx2munin.jar \
     -url service:jmx:rmi:///jndi/rmi://localhost:7199/jmxrmi \
     -query "org.apache.cassandra.*:*" \
     -enums /path/to/enums.cfg

Now matching values get replaced by their numerical representation. On the left needs to be a unique number on the right side is a regular expression. If a string cannot be matched according to the spec "U" for "undefined" will be returned.

License

Licensed under the Apache License, Version 2.0 (the "License") You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0

Versions

Version
1.0