1
0
mirror of https://github.com/c-kr/check_json.git synced 2024-11-23 10:53:47 +01:00

added performance stats and cleaned up code

This commit is contained in:
Benjamin Rokseth 2014-01-23 22:38:12 +01:00
parent 33d2c1209a
commit b716491160
2 changed files with 47 additions and 35 deletions

View File

@ -5,10 +5,20 @@ Nagios plugin to check JSON attributes via http(s).
This Plugin is a fork of the existing JSON Plugin from https://github.com/bbuchalter/check_json with the enhancements of using the Nagios::Plugin Perl Module, allowing to use thresholds and performance data collection from various json attributes. This Plugin is a fork of the existing JSON Plugin from https://github.com/bbuchalter/check_json with the enhancements of using the Nagios::Plugin Perl Module, allowing to use thresholds and performance data collection from various json attributes.
Usage: `check_json -U <URL> -a <attribute> [ -v|--verbose ] [-t <timeout>] [ -c|--critical <threshold> ] [ -w|--warning <threshold> ]` Performance data is also enhanced to extract performance data compliant to Nagios and Graphite standards. One attribute is selected for thresholds check, multiple others can be added for extracting performance data. This plugin is aimed at simplifying Nagios, Icinga & Icinga2 polling of JSON status APIs.
Usage:
```
check_json -u|--url <URL> -a|--attribute <attribute> [ -c|--critical <threshold> ] [ -w|--warning <threshold> ] [ -p|--perfvars <fields> ] [ -t|--timeout <timeout> ] [ -d|--divisor <divisor> ] [ -h|--help ]
```
Example: Example:
```
./check_json.pl --url http://192.168.5.10:9332/local_stats --attribute '{shares}->{dead_shares}' --warning :5 --critical :10 --perfvars '{shares}->{dead_shares},{shares}->{live_shares},{clients}->{clients_connected}'
```
`check_json.pl -U http://192.168.5.10:9332/local_stats -a '{shares}->{dead}' -w :5 -c :10` Result:
```
Check JSON status API OK - dead_shares: 2, live_shares: 12, clients_connected: 234 | dead_shares=2;5;10 live_shares=12 clients_connected=234
```
JSON OK - 2 | value=2;;

View File

@ -8,15 +8,17 @@ use Nagios::Plugin;
use Data::Dumper; use Data::Dumper;
my $np = Nagios::Plugin->new( my $np = Nagios::Plugin->new(
usage => "Usage: %s -U <URL> -a|--attribute <attribute> [-t|--timeout <timeout>] " usage => "Usage: %s -u|--url <URL> -a|--attribute <attribute> "
. "[ -c|--critical <threshold> ] [ -w|--warning <threshold> ] " . "[ -c|--critical <threshold> ] [ -w|--warning <threshold> ] "
. "[ -a|--attribute <attribute> ] " . "[ -p|--perfvars <fields> ] "
. "[ -D|--divisor <divisor> ] " . "[ -t|--timeout <timeout> ] "
. "[ -p|--perfvars <fields> ]", . "[ -d|--divisor <divisor> ] "
. "[ -h|--help ] ",
version => '0.2', version => '0.2',
blurb => 'Nagios plugin to check JSON attributes via http(s)', blurb => 'Nagios plugin to check JSON attributes via http(s)',
extra => "\nExample: \n" extra => "\nExample: \n"
. "check_json.pl -U http://192.168.5.10:9332/local_stats -a '{shares}->{dead}' -w :5 -c :10", . "check_json.pl --url http://192.168.5.10:9332/local_stats --attribute '{shares}->{dead}' "
. "--warning :5 --critical :10 --perfvars '{shares}->{dead},{shares}->{live}'",
url => 'https://github.com/c-kr/check_json', url => 'https://github.com/c-kr/check_json',
plugin => 'check_json', plugin => 'check_json',
timeout => 15, timeout => 15,
@ -25,8 +27,8 @@ my $np = Nagios::Plugin->new(
# add valid command line options and build them into your usage/help documentation. # add valid command line options and build them into your usage/help documentation.
$np->add_arg( $np->add_arg(
spec => 'URL|U=s', spec => 'url|u=s',
help => '-U, --URL http://192.168.5.10:9332/local_stats', help => '-u, --url (eg. http://192.168.5.10:9332/local_stats}',
required => 1, required => 1,
); );
$np->add_arg( $np->add_arg(
@ -35,8 +37,8 @@ $np->add_arg(
required => 1, required => 1,
); );
$np->add_arg( $np->add_arg(
spec => 'divisor|D=i', spec => 'divisor|d=i',
help => '-D, --divisor 1000000', help => '-d, --divisor 1000000',
); );
$np->add_arg( $np->add_arg(
spec => 'warning|w=s', spec => 'warning|w=s',
@ -52,7 +54,8 @@ $np->add_arg(
); );
$np->add_arg( $np->add_arg(
spec => 'perfvars|p=s', spec => 'perfvars|p=s',
help => '-p, --perfvars INTEGER:INTEGER . CSV list of fields from JSON response to include in perfdata ', help => '-p, --perfvars . CSV list of fields from JSON response to include in perfdata '
. '{shares}->{dead},{shares}->{live}',
); );
## Parse @ARGV and process standard arguments (e.g. usage, help, version) ## Parse @ARGV and process standard arguments (e.g. usage, help, version)
@ -69,7 +72,7 @@ $ua->parse_head(0);
$ua->timeout($np->opts->timeout); $ua->timeout($np->opts->timeout);
if ($np->opts->verbose) { (print Dumper ($ua))}; if ($np->opts->verbose) { (print Dumper ($ua))};
my $response = ($ua->get($np->opts->URL)); my $response = ($ua->get($np->opts->url));
if ($response->is_success) { if ($response->is_success) {
if (!($response->header("content-type") =~ 'application/json')) { if (!($response->header("content-type") =~ 'application/json')) {
@ -86,11 +89,9 @@ if ($np->opts->verbose) { (print Dumper ($json_response))};
my $check_value; my $check_value;
my $check_value_str = '$check_value = $json_response->'.$np->opts->attribute; my $check_value_str = '$check_value = $json_response->'.$np->opts->attribute;
# if ($np->opts->verbose) { (print Dumper ($exec))}; if ($np->opts->verbose) { (print Dumper ($check_value_str))};
eval $check_value_str; eval $check_value_str;
#$attribute_value = $json_response->{eval $np->opts->attribute};
if (!defined $check_value) { if (!defined $check_value) {
$np->nagios_exit(UNKNOWN, "No value received"); $np->nagios_exit(UNKNOWN, "No value received");
} }
@ -101,38 +102,39 @@ if (defined $np->opts->divisor) {
my $result = $np->check_threshold($check_value); my $result = $np->check_threshold($check_value);
my @perfdata; my @statusmsg;
# routine to add perfdata from JSON response based on a loop of keys given in perfvals (csv) # routine to add perfdata from JSON response based on a loop of keys given in perfvals (csv)
if ($np->opts->perfvars) { if ($np->opts->perfvars) {
foreach my $key (split(',', $np->opts->perfvars)) { foreach my $key (split(',', $np->opts->perfvars)) {
# use last element of key as label # use last element of key as label
my $label = (split('->', $key))[-1]; my $label = (split('->', $key))[-1];
# make label ascii compatible
$label =~ s/[^a-zA-Z0-9_-]//g ; $label =~ s/[^a-zA-Z0-9_-]//g ;
my $perf_val; my $perf_val;
$perf_val = eval '$json_response->'.$key; $perf_val = eval '$json_response->'.$key;
print Dumper ("JSON key: ".$label.", JSON val: " . eval $perf_val); if ($np->opts->verbose) { print Dumper ("JSON key: ".$label.", JSON val: " . $perf_val) };
if ($np->opts->verbose) { print Dumper ("JSON key: ".$label.", JSON val: " . eval $perf_val) };
if ( defined($perf_val) ) { if ( defined($perf_val) ) {
push(@perfdata, {label => lc $label, value => $perf_val}); push(@statusmsg, "$label: $perf_val");
# add threshold if attribute option matches key
if ($key eq $np->opts->attribute) {
$np->add_perfdata(
label => lc $label,
value => $perf_val,
threshold => $np->threshold(),
);
} else {
$np->add_perfdata( $np->add_perfdata(
label => lc $label, label => lc $label,
value => $perf_val, value => $perf_val,
#threshold => $np->threshold(),
); );
} }
} }
} }
sub pp {
my $h = shift();
qq[{${\(join',',map"$_=>$h->{$_}",keys%$h)}}]
} }
print Dumper (@perfdata);
$np->nagios_exit( $np->nagios_exit(
return_code => $result, return_code => $result,
message => pp @perfdata, message => join(', ', @statusmsg),
); );