package Monitoring::Plugin::Performance; use 5.006; use strict; use warnings; use Carp; use base qw(Class::Accessor::Fast); __PACKAGE__->mk_ro_accessors( qw(label value uom warning critical min max) ); use Monitoring::Plugin::Functions; use Monitoring::Plugin::Threshold; use Monitoring::Plugin::Range; our ($VERSION) = $Monitoring::Plugin::Functions::VERSION; sub import { my ($class, %attr) = @_; $_ = $attr{use_die} || 0; Monitoring::Plugin::Functions::_use_die($_); } # This is NOT the same as N::P::Functions::value_re. We leave that to be the strict # version. This one allows commas to be part of the numeric value. my $value = qr/[-+]?[\d\.,]+/; my $value_re = qr/$value(?:e$value)?/; my $value_with_negative_infinity = qr/$value_re|~/; sub _parse { my $class = shift; my $string = shift; $string =~ /^'?([^'=]+)'?=($value_re)([\w%]*);?($value_with_negative_infinity\:?$value_re?)?;?($value_with_negative_infinity\:?$value_re?)?;?($value_re)?;?($value_re)?/o; return undef unless ((defined $1 && $1 ne "") && (defined $2 && $2 ne "")); my @info = ($1, $2, $3, $4, $5, $6, $7); # We convert any commas to periods, in the value fields map { defined $info[$_] && $info[$_] =~ s/,/./go } (1, 3, 4, 5, 6); # Check that $info[1] is an actual value # We do this by returning undef if a warning appears my $performance_value; { my $not_value; local $SIG{__WARN__} = sub { $not_value++ }; $performance_value = $info[1]+0; return undef if $not_value; } my $p = $class->new( label => $info[0], value => $performance_value, uom => $info[2], warning => $info[3], critical => $info[4], min => $info[5], max => $info[6] ); return $p; } # Map undef to '' sub _nvl { my ($self, $value) = @_; defined $value ? $value : '' } sub perfoutput { my $self = shift; # Add quotes if label contains a space character my $label = $self->label; if ($label =~ / /) { $label = "'$label'"; } my $value = $self->value; # To prevent invalid output, we change empty value to value "U" if ($value eq '') { $value = 'U'; } my $out = sprintf "%s=%s%s;%s;%s;%s;%s", $label, $value, $self->_nvl($self->uom), $self->_nvl($self->warning), $self->_nvl($self->critical), $self->_nvl($self->min), $self->_nvl($self->max); # Previous implementation omitted trailing ;; - do we need this? $out =~ s/;;$//; return $out; } sub parse_perfstring { my ($class, $perfstring) = @_; my @perfs = (); my $obj; while ($perfstring) { $perfstring =~ s/^\s*//; # If there is more than 1 equals sign, split it out and parse individually if (@{[$perfstring =~ /=/g]} > 1) { $perfstring =~ s/^(.*?=.*?)\s//; if (defined $1) { $obj = $class->_parse($1); } else { # This could occur if perfdata was soemthing=value= # Since this is invalid, we reset the string and continue $perfstring = ""; $obj = $class->_parse($perfstring); } } else { $obj = $class->_parse($perfstring); $perfstring = ""; } push @perfs, $obj if $obj; } return @perfs; } sub rrdlabel { my $self = shift; my $name = $self->clean_label; # Shorten return substr( $name, 0, 19 ); } sub clean_label { my $self = shift; my $name = $self->label; if ($name eq "/") { $name = "root"; } elsif ( $name =~ s/^\/// ) { $name =~ s/\//_/g; } # Convert all other characters $name =~ s/\W/_/g; return $name; } # Backward compatibility: create a threshold object on the fly as requested sub threshold { my $self = shift; return Monitoring::Plugin::Threshold->set_thresholds( warning => $self->warning, critical => $self->critical ); } # Constructor - unpack thresholds, map args to hashref sub new { my $class = shift; my %arg = @_; # Convert thresholds if (my $threshold = delete $arg{threshold}) { $arg{warning} ||= $threshold->warning . ""; $arg{critical} ||= $threshold->critical . ""; } $class->SUPER::new(\%arg); } 1; __END__ =head1 NAME Monitoring::Plugin::Performance - class for handling Monitoring::Plugin performance data. =head1 SYNOPSIS use Monitoring::Plugin::Performance use_die => 1; # Constructor (also accepts a 'threshold' obj instead of warning/critical) $p = Monitoring::Plugin::Performance->new( label => 'size', value => $value, uom => "kB", warning => $warning, critical => $critical, min => $min, max => $max, ); # Parser @perf = Monitoring::Plugin::Performance->parse_perfstring( "/=382MB;15264;15269;; /var=218MB;9443;9448" ) or warn("Failed to parse perfstring"); # Accessors for $p (@perf) { printf "label: %s\n", $p->label; printf "value: %s\n", $p->value; printf "uom: %s\n", $p->uom; printf "warning: %s\n", $p->warning; printf "critical: %s\n", $p->critical; printf "min: %s\n", $p->min; printf "max: %s\n", $p->max; # Special accessor returning a threshold obj containing warning/critical $threshold = $p->threshold; } # Perfdata output format i.e. label=value[uom];[warn];[crit];[min];[max] print $p->perfoutput; =head1 DESCRIPTION Monitoring::Plugin class for handling performance data. This is a public interface because it could be used by performance graphing routines, such as nagiostat (http://nagiostat.sourceforge.net), perfparse (http://perfparse.sourceforge.net), nagiosgraph (http://nagiosgraph.sourceforge.net) or NagiosGrapher (http://www.nagiosexchange.org/NagiosGrapher.84.0.html). Monitoring::Plugin::Performance offers both a parsing interface (via parse_perfstring), for turning nagios performance output strings into their components, and a composition interface (via new), for turning components into perfdata strings. =head1 USE'ING THE MODULE If you are using this module for the purposes of parsing perf data, you will probably want to set use_die => 1 at use time. This forces &Monitoring::Plugin::Functions::plugin_exit to call die() - rather than exit() - when an error occurs. This is then trappable by an eval. If you don't set use_die, then an error in these modules will cause your script to exit =head1 CLASS METHODS =over 4 =item Monitoring::Plugin::Performance->new(%attributes) Instantiates a new Monitoring::Plugin::Performance object with the given attributes. =item Monitoring::Plugin::Performance->parse_perfstring($string) Returns an array of Monitoring::Plugin::Performance objects based on the string entered. If there is an error parsing the string - which may consists of several sets of data - will return an array with all the successfully parsed sets. If values are input with commas instead of periods, due to different locale settings, then it will still be parsed, but the commas will be converted to periods. =back =head1 OBJECT METHODS (ACCESSORS) =over 4 =item label, value, uom, warning, critical, min, max These all return scalars. min and max are not well supported yet. =item threshold Returns a Monitoring::Plugin::Threshold object holding the warning and critical ranges for this performance data (if any). =item rrdlabel Returns a string based on 'label' that is suitable for use as dataset name of an RRD i.e. munges label to be 1-19 characters long with only characters [a-zA-Z0-9_]. This calls $self->clean_label and then truncates to 19 characters. There is no guarantee that multiple N:P:Performance objects will have unique rrdlabels. =item clean_label Returns a "clean" label for use as a dataset name in RRD, ie, it converts characters that are not [a-zA-Z0-9_] to _. It also converts "/" to "root" and "/{name}" to "{name}". =item perfoutput Outputs the data in Monitoring::Plugin perfdata format i.e. label=value[uom];[warn];[crit];[min];[max]. =back =head1 SEE ALSO Monitoring::Plugin, Monitoring::Plugin::Threshold, https://www.monitoring-plugins.org/doc/guidelines.html =head1 AUTHOR This code is maintained by the Monitoring Plugin Development Team: see https://monitoring-plugins.org =head1 COPYRIGHT AND LICENSE Copyright (C) 2014 by Monitoring Plugin Team Copyright (C) 2006-2014 by Nagios Plugin Development Team This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself. =cut