1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
|
package Nagios::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 Nagios::Plugin::Functions;
use Nagios::Plugin::Threshold;
use Nagios::Plugin::Range;
our ($VERSION) = $Nagios::Plugin::Functions::VERSION;
sub import {
my ($class, %attr) = @_;
$_ = $attr{use_die} || 0;
Nagios::Plugin::Functions::_use_die($_);
}
my $value_re = qr/[-+]?[\d\.]+/;
my $value_re_with_negative_infinity = qr/$value_re|~/;
sub _parse {
my $class = shift;
my $string = shift;
$string =~ s/^([^=]+)=($value_re)([\w%]*);?($value_re_with_negative_infinity\:?$value_re?)?;?($value_re_with_negative_infinity\:?$value_re?)?;?($value_re)?;?($value_re)?\s*//o;
return undef unless ((defined $1 && $1 ne "") && (defined $2 && $2 ne ""));
my $p = $class->new(
label => $1, value => $2+0, uom => $3, warning => $4, critical => $5,
min => $6, max => $7
);
return ($p, $string);
}
# Map undef to ''
sub _nvl {
my ($self, $value) = @_;
defined $value ? $value : ''
}
sub perfoutput {
my $self = shift;
my $out = sprintf "%s=%s%s;%s;%s;%s;%s",
$self->label,
$self->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) {
($obj, $perfstring) = $class->_parse($perfstring);
return () unless $obj;
push @perfs, $obj;
}
return @perfs;
}
sub rrdlabel {
my $self = shift;
my $name = $self->label;
if ($name eq "/") {
$name = "root";
}
# If filesystem name, remove initial / and convert subsequent "/" to "_"
elsif ($name =~ s/^\///) {
$name =~ s/\//_/g;
}
# Convert bad chars
$name =~ s/\W/_/g;
# Shorten
return substr( $name, 0, 19 );
}
# Backward compatibility: create a threshold object on the fly as requested
sub threshold
{
my $self = shift;
return Nagios::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
Nagios::Plugin::Performance - class for handling Nagios::Plugin
performance data.
=head1 SYNOPSIS
use Nagios::Plugin::Performance use_die => 1;
# Constructor (also accepts a 'threshold' obj instead of warning/critical)
$p = Nagios::Plugin::Performance->new(
label => 'size',
value => $value,
uom => "kB",
warning => $warning,
critical => $critical,
min => $min,
max => $max,
);
# Parser
@perf = Nagios::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
Nagios::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).
Nagios::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
&Nagios::Plugin::Functions::nagios_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 Nagios::Plugin::Performance->new(%attributes)
Instantiates a new Nagios::Plugin::Performance object with the given
attributes.
=item Nagios::Plugin::Performance->parse_perfstring($string)
Returns an array of Nagios::Plugin::Performance objects based on the string
entered. If there is an error parsing the string, an empty array is returned.
=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 Nagios::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_].
There is no guarantee that multiple N:P:Performance objects will have unique
rrdlabels.
=item perfoutput
Outputs the data in Nagios::Plugin perfdata format i.e.
label=value[uom];[warn];[crit];[min];[max].
=back
=head1 SEE ALSO
Nagios::Plugin, Nagios::Plugin::Threshold, http://nagiosplug.sourceforge.net.
=head1 AUTHOR
This code is maintained by the Nagios Plugin Development Team: see
http://nagiosplug.sourceforge.net.
=head1 COPYRIGHT AND LICENSE
Copyright (C) 2006-2007 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
|
