Java Applications and Servers

check_jstat

Write a Review

Description:

A Nagios plugin to get memory statistics of a Java application using jstat

Current Version

1.2

Last Release Date

2012-08-23

Compatible With

  • Nagios 3.x

Owner

Eric Blanchard

Website

http://github.com/Ericbla/check_jstat

Download URL

http://github.com/Ericbla/check_jstat

License

LGPL

Copy Page Link Recommend Login to Add to Favorites
Project Files
FileDescription
check_jstat.sh

The check command

Project Notes

A Nagios plugin to get memory statistics of a Java application using jstat.

The process selection is done either by:

  • its pid (-p )
  • its service name (-s ) (assuming there is a /var/run/.pid file holding its pid)
  • its java name (-j ) where the java name depends ob how the java application has been launched (main class or jar/war in case of java -jar) (see jps).

It then call jstat -gc and jstat -gccapacity to catch current and maximum heap and perm sizes. What is called heap here is the edden + old generation space, while perm represents the permanent generation space.

If specified (with -w and -c options) values can be checked with WARNING or CRITICAL thresholds (apply to both heap and perm regions).

This plugin also attach perfomance data to the output:
pid=pid
heap=heap-size-used;heap-max-size;%ratio;warning-threshold-%ratio;critical-threshold-%ratio
perm=perm-size-used;perm-max-size;%ratio;warning-threshold-%ratio;critical-threshold-%ratio

Usage: 

    chech_jstat.sh -v  
        Print version and exit"  
    chech_jstat.sh -h  
        Print this help nd exit  
    chech_jstat.sh -p  [-w <%ratio>] [-c <%ratio>]  
    chech_jstat.sh -s  [-w <%ratio>] [-c <%ratio>]  
    chech_jstat.sh -j  [-w <%ratio>] [-c <%ratio>]  
        -p        the PID of process to monitor  
        -s    the service name of process to monitor  
        -j  the java app (see jps) process to monitor  
                       if this name in blank (-j '') any java app is  
                       looked for (as long there is only one)  
        -w <%> the warning threshold ratio current/max in %  
        -c <%> the critical threshold ratio current/max in %

This plugin may require to be run with sudo. In this case add a configuration in /etc/sudoers. For example if nagios is the user that run nagios (or NRPE deamon): 

Defaults:nagios	!requiretty
nagios ALL=(root) NOPASSWD: /opt/nagios/libexec/check_jstat.sh

Reviews (5) Add a Review
Problem after upgrade to JDK 1.8 Update 31
by jvedreno, February 28, 2015

Hi, This plugin was working nice for me. Yesterday I have upgraded JDK version to JDK 1.8 Update 31 and the plugin responds that 'can't find the process' (and the process exists).


Good, but wrong performance data format
by danci1973, July 31, 2014

It seems that the performance data is not in the expected 'Nagios plugins' format, which makes it hard(er) to graph these values. The expected format is: 'label'=value[UOM];[warn];[crit];[min];[max] https://nagios-plugins.org/doc/guidelines.html#AEN200 http://docs.icinga.org/latest/en/perfdata.html#formatperfdata


Calculation of heap size
by Croesus, August 31, 2013

Nice plugin! One thing though - for heap size capacity the script adds the values for EU and OU - but shouldn't it also add S0U?


Work but additional configuration is required
by Thundr, July 31, 2013

Hi, i have probe this plugin, and it works only with root user, i have added the config in /etc/sudoers but mi execution with user nagios is the following: -bash-4.1$ cd /srv/nagios/libexec/ -bash-4.1$ ./check_jstat.sh -s tomcat6 Could not attach to 11922 CRITICAL: Can't get GC statistics I think that the problem is in jstat, which don´t have permissions to see all java process (all users). I add permisions to /etc/sudoers: nagios ALL=(root) NOPASSWD: /usr/bin/jstat And modify the plugin included "sudo" in calls to jstat lines: gc=$(sudo jstat -gc $pid | tail -1 | sed -e 's/[ ][ ]*/ /g') gccapacity=$(sudo jstat -gccapacity $pid | tail -1 | sed -e 's/[ ][ ]*/ /g') And works perfectly! If there is any alternative solution may be welcome :) Good work!


Small bug and sidenote
by harakiri, August 31, 2012

The author copied code and forgot to adapt a variable. Line 143 and 147: 'cs' should become 'ws' (otherwise no warning treshhold) For all else this works fine. Jstat is also less intrusive to your JVM than jmap. Be sure to add this plugin to /etc/sudoers or run the test as the same uid as the JVM. Otherwise jstat will get access denied.


Add a Review

You must be logged in to submit a review.

Thank you for your review!

Your review has been submitted and is pending approval.

Recommend

To:


From:


Thank you for your recommendation!

Your recommendation has been sent.

Page Sections
Project Overview Project Files Project Notes Reviews
Project Stats
Rating
4 (8)
Favorites
2
Views
84,601