Monitorix/lib/ambsens.pm

553 lines
17 KiB
Perl

#
# Monitorix - A lightweight system monitoring tool.
#
# Copyright (C) 2005-2022 by Jordi Sanfeliu <jordi@fibranet.cat>
#
# This program is free software; you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 2 of the License, or
# (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License along
# with this program; if not, write to the Free Software Foundation, Inc.,
# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
#
package ambsens;
use strict;
use warnings;
use Monitorix;
use RRDs;
use POSIX qw(strftime);
use Exporter 'import';
our @EXPORT = qw(ambsens_init ambsens_update ambsens_cgi);
sub ambsens_init {
my $myself = (caller(0))[3];
my ($package, $config, $debug) = @_;
my $rrd = $config->{base_lib} . $package . ".rrd";
my $ambsens = $config->{ambsens};
my $info;
my @ds;
my @rra;
my @tmp;
my $n;
my @average;
my @min;
my @max;
my @last;
if(-e $rrd) {
$info = RRDs::info($rrd);
for my $key (keys %$info) {
if(index($key, 'ds[') == 0) {
if(index($key, '.type') != -1) {
push(@ds, substr($key, 3, index($key, ']') - 3));
}
}
if(index($key, 'rra[') == 0) {
if(index($key, '.rows') != -1) {
push(@rra, substr($key, 4, index($key, ']') - 4));
}
}
}
if(scalar(@ds) / 9 != scalar(my @fl = split(',', $ambsens->{list}))) {
logger("$myself: Detected size mismatch between 'list' (" . scalar(my @fl = split(',', $ambsens->{list})) . ") and $rrd (" . scalar(@ds) / 9 . "). Resizing it accordingly. All historical data will be lost. Backup file created.");
rename($rrd, "$rrd.bak");
}
if(scalar(@rra) < 12 + (4 * $config->{max_historic_years})) {
logger("$myself: Detected size mismatch between 'max_historic_years' (" . $config->{max_historic_years} . ") and $rrd (" . ((scalar(@rra) -12) / 4) . "). Resizing it accordingly. All historical data will be lost. Backup file created.");
rename($rrd, "$rrd.bak");
}
}
if(!(-e $rrd)) {
logger("Creating '$rrd' file.");
for($n = 1; $n <= $config->{max_historic_years}; $n++) {
push(@average, "RRA:AVERAGE:0.5:1440:" . (365 * $n));
push(@min, "RRA:MIN:0.5:1440:" . (365 * $n));
push(@max, "RRA:MAX:0.5:1440:" . (365 * $n));
push(@last, "RRA:LAST:0.5:1440:" . (365 * $n));
}
for($n = 0; $n < scalar(my @sl = split(',', $ambsens->{list})); $n++) {
push(@tmp, "DS:ambsens" . $n . "_s1:GAUGE:120:U:U");
push(@tmp, "DS:ambsens" . $n . "_s2:GAUGE:120:U:U");
push(@tmp, "DS:ambsens" . $n . "_s3:GAUGE:120:U:U");
push(@tmp, "DS:ambsens" . $n . "_s4:GAUGE:120:U:U");
push(@tmp, "DS:ambsens" . $n . "_s5:GAUGE:120:U:U");
push(@tmp, "DS:ambsens" . $n . "_s6:GAUGE:120:U:U");
push(@tmp, "DS:ambsens" . $n . "_s7:GAUGE:120:U:U");
push(@tmp, "DS:ambsens" . $n . "_s8:GAUGE:120:U:U");
push(@tmp, "DS:ambsens" . $n . "_s9:GAUGE:120:U:U");
}
eval {
RRDs::create($rrd,
"--step=60",
@tmp,
"RRA:AVERAGE:0.5:1:1440",
"RRA:AVERAGE:0.5:30:336",
"RRA:AVERAGE:0.5:60:744",
@average,
"RRA:MIN:0.5:1:1440",
"RRA:MIN:0.5:30:336",
"RRA:MIN:0.5:60:744",
@min,
"RRA:MAX:0.5:1:1440",
"RRA:MAX:0.5:30:336",
"RRA:MAX:0.5:60:744",
@max,
"RRA:LAST:0.5:1:1440",
"RRA:LAST:0.5:30:336",
"RRA:LAST:0.5:60:744",
@last,
);
};
my $err = RRDs::error;
if($@ || $err) {
logger("$@") unless !$@;
if($err) {
logger("ERROR: while creating $rrd: $err");
if($err eq "RRDs::error") {
logger("... is the RRDtool Perl package installed?");
}
}
return;
}
}
$config->{ambsens_hist_alerts} = ();
push(@{$config->{func_update}}, $package);
logger("$myself: Ok") if $debug;
}
sub ambsens_update {
my $myself = (caller(0))[3];
my ($package, $config, $debug) = @_;
my $rrd = $config->{base_lib} . $package . ".rrd";
my $ambsens = $config->{ambsens};
my @sens;
my $n;
my $str;
my $rrdata = "N";
my $e = 0;
while($e < scalar(my @sl = split(',', $ambsens->{list}))) {
my $e2 = 1;
foreach my $dl (split(',', $ambsens->{desc}->{$e})) {
my $str = trim($dl);
my $script_with_arguments = trim($ambsens->{cmd}->{$str});
my $script = (split(' ', $script_with_arguments))[0];
if($script) {
if(-x $script) {
my $val = `$script_with_arguments`;
chomp($val);
$sens[$e][$e2] = $val;
# check alerts for each sensor defined
my @al = split(',', $ambsens->{alerts}->{$str} || "");
if(scalar(@al)) {
my $timeintvl = trim($al[0]);
my $threshold = trim($al[1]);
my $script = trim($al[2]);
my $when = lc(trim($al[3] || ""));
my @range = split('-', $threshold);
$threshold = 0 if !$threshold;
if(scalar(@range) == 1) {
$when = "above" if !$when; # 'above' is the default
if($when eq "above" && $val < $threshold) {
$config->{ambsens_hist_alerts}->{$str} = 0;
} elsif($when eq "below" && $val > $threshold) {
$config->{ambsens_hist_alerts}->{$str} = 0;
} else {
if($when eq "above" || $when eq "below") {
if(!$config->{ambsens_hist_alerts}->{$str}) {
$config->{ambsens_hist_alerts}->{$str} = time;
}
if($config->{ambsens_hist_alerts}->{$str} > 0 && (time - $config->{ambsens_hist_alerts}->{$str}) >= $timeintvl) {
if(-x $script) {
logger("$myself: alert on Ambient Sensor ($str): executing script '$script'.");
system($script . " " . $timeintvl . " " . $threshold . " " . $val);
} else {
logger("$myself: ERROR: script '$script' doesn't exist or don't has execution permissions.");
}
$config->{ambsens_hist_alerts}->{$str} = time;
}
} else {
logger("$myself: ERROR: invalid when value '$when'");
}
}
} elsif(scalar(@range) == 2) {
if($when) {
logger("$myself: the forth parameter ('$when') in '$str' is irrelevant when there are range values defined.");
}
if($range[0] == $range[1]) {
logger("$myself: ERROR: range values are identical.");
} else {
if($val <= $range[0]) {
$config->{ambsens_hist_alerts}->{$str}->{above} = 0;
if($val < $range[0] && !$config->{ambsens_hist_alerts}->{$str}->{below}) {
$config->{ambsens_hist_alerts}->{$str}->{below} = time;
}
}
if($val >= $range[1]) {
$config->{ambsens_hist_alerts}->{$str}->{below} = 0;
if($val > $range[1] && !$config->{ambsens_hist_alerts}->{$str}->{above}) {
$config->{ambsens_hist_alerts}->{$str}->{above} = time;
}
}
if($config->{ambsens_hist_alerts}->{$str}->{below} > 0 && (time - $config->{ambsens_hist_alerts}->{$str}->{below}) >= $timeintvl) {
if(-x $script) {
logger("$myself: alert on Ambient Sensor ($str): executing script '$script'.");
system($script . " " . $timeintvl . " " . $threshold . " " . $val);
} else {
logger("$myself: ERROR: script '$script' doesn't exist or don't has execution permissions.");
}
$config->{ambsens_hist_alerts}->{$str}->{below} = time;
}
if($config->{ambsens_hist_alerts}->{$str}->{above} > 0 && (time - $config->{ambsens_hist_alerts}->{$str}->{above}) >= $timeintvl) {
if(-x $script) {
logger("$myself: alert on Ambient Sensor ($str): executing script '$script'.");
system($script . " " . $timeintvl . " " . $threshold . " " . $val);
} else {
logger("$myself: ERROR: script '$script' doesn't exist or don't has execution permissions.");
}
$config->{ambsens_hist_alerts}->{$str}->{above} = time;
}
}
} else {
logger("$myself: ERROR: invalid threshold value '$threshold'");
}
}
} else {
logger("$myself: ERROR: script '$script' doesn't exist or don't has execution permissions.");
}
}
$e2++;
}
$e++;
}
$e = 0;
while($e < scalar(my @sl = split(',', $ambsens->{list}))) {
for($n = 1; $n <= 9; $n++) {
$sens[$e][$n] = 0 unless defined $sens[$e][$n];
$rrdata .= ":" . $sens[$e][$n];
}
$e++;
}
RRDs::update($rrd, $rrdata);
logger("$myself: $rrdata") if $debug;
my $err = RRDs::error;
logger("ERROR: while updating $rrd: $err") if $err;
}
sub ambsens_cgi {
my ($package, $config, $cgi) = @_;
my @output;
my $ambsens = $config->{ambsens};
my @rigid = split(',', ($ambsens->{rigid} || ""));
my @limit = split(',', ($ambsens->{limit} || ""));
my $tf = $cgi->{tf};
my $colors = $cgi->{colors};
my $graph = $cgi->{graph};
my $silent = $cgi->{silent};
my $zoom = "--zoom=" . $config->{global_zoom};
my %rrd = (
'new' => \&RRDs::graphv,
'old' => \&RRDs::graph,
);
my $version = "new";
my @full_size_mode;
my $pic;
my $picz;
my $picz_width;
my $picz_height;
my $u = "";
my $width;
my $height;
my @extra;
my @riglim;
my @IMG;
my @IMGz;
my @tmp;
my @tmpz;
my @CDEF;
my $n;
my $n2;
my $str;
my $err;
my @LC = (
"#4444EE",
"#EEEE44",
"#44EEEE",
"#EE44EE",
"#888888",
"#E29136",
"#44EE44",
"#448844",
"#EE4444",
);
$version = "old" if $RRDs::VERSION < 1.3;
push(@full_size_mode, "--full-size-mode") if $RRDs::VERSION > 1.3;
my $rrd = $config->{base_lib} . $package . ".rrd";
my $title = $config->{graph_title}->{$package};
my $IMG_DIR = $config->{base_dir} . "/" . $config->{imgs_dir};
my $imgfmt_uc = uc($config->{image_format});
my $imgfmt_lc = lc($config->{image_format});
foreach my $i (split(',', $config->{rrdtool_extra_options} || "")) {
push(@extra, trim($i)) if trim($i);
}
$title = !$silent ? $title : "";
# text mode
#
if(lc($config->{iface_mode}) eq "text") {
if($title) {
push(@output, main::graph_header($title, 2));
push(@output, " <tr>\n");
push(@output, " <td>\n");
}
my (undef, undef, undef, $data) = RRDs::fetch("$rrd",
"--resolution=$tf->{res}",
"--start=-$tf->{nwhen}$tf->{twhen}",
"AVERAGE");
$err = RRDs::error;
push(@output, "ERROR: while fetching $rrd: $err\n") if $err;
my $line1;
my $line2;
my $line3;
push(@output, " <pre style='font-size: 12px; color: $colors->{fg_color}';>\n");
push(@output, " ");
for($n = 0; $n < scalar(my @sl = split(',', $ambsens->{list})); $n++) {
$line1 = "";
foreach my $dl (split(',', $ambsens->{desc}->{$n})) {
$dl = trim($dl);
$str = $ambsens->{map}->{$dl} || $dl;
$str = sprintf("%7s", substr($str, 0, 5));
$line1 .= " ";
$line2 .= sprintf(" %7s", $str);
$line3 .= "--------";
}
if($line1) {
my $i = length($line1);
push(@output, sprintf(sprintf("%${i}s", sprintf("%s", trim($sl[$n])))));
}
}
push(@output, "\n");
push(@output, "Time$line2\n");
push(@output, "----$line3 \n");
my $line;
my $time;
my $n2;
my $n3;
my $from;
my $to;
for($n = 0, $time = $tf->{tb}; $n < ($tf->{tb} * $tf->{ts}); $n++) {
$line = @$data[$n];
$time = $time - (1 / $tf->{ts});
push(@output, sprintf(" %2d$tf->{tc} ", $time));
for($n2 = 0; $n2 < scalar(my @sl = split(',', $ambsens->{list})); $n2++) {
$n3 = $n2 * 9;
foreach my $dl (split(',', $ambsens->{desc}->{$n2})) {
$from = $n3++;
$to = $from + 1;
my ($j) = @$line[$from..$to];
push(@output, sprintf("%7.1lf ", celsius_to($config, $j) || 0));
}
}
push(@output, "\n");
}
push(@output, " </pre>\n");
if($title) {
push(@output, " </td>\n");
push(@output, " </tr>\n");
push(@output, main::graph_footer());
}
push(@output, " <br>\n");
return @output;
}
# graph mode
#
if($silent eq "yes" || $silent eq "imagetag") {
$colors->{fg_color} = "#000000"; # visible color for text mode
$u = "_";
}
if($silent eq "imagetagbig") {
$colors->{fg_color} = "#000000"; # visible color for text mode
$u = "";
}
for($n = 0; $n < scalar(my @sl = split(',', $ambsens->{list})); $n++) {
$str = $u . $package . $n . "." . $tf->{when} . ".$imgfmt_lc";
push(@IMG, $str);
unlink("$IMG_DIR" . $str);
if(lc($config->{enable_zoom}) eq "y") {
$str = $u . $package . $n . "z." . $tf->{when} . ".$imgfmt_lc";
push(@IMGz, $str);
unlink("$IMG_DIR" . $str);
}
}
my $use_scientific_notation = lc($ambsens->{scientific_notation} || "") eq "y" ? 1 : 0;
my $show_average = lc($ambsens->{show_average} || "") eq "y" ? 1 : 0;
my $value_format = $use_scientific_notation ? "%6.1lf%s" : "%7.1lf" ;
@riglim = @{setup_riglim($rigid[0], $limit[0])};
$n = 0;
while($n < scalar(my @sl = split(',', $ambsens->{list}))) {
if($title) {
if($n == 0) {
push(@output, main::graph_header($title, $ambsens->{graphs_per_row}));
}
push(@output, " <tr>\n");
}
for($n2 = 0; $n2 < $ambsens->{graphs_per_row}; $n2++) {
last unless $n < scalar(my @sl = split(',', $ambsens->{list}));
if($title) {
push(@output, " <td>\n");
}
undef(@tmp);
undef(@tmpz);
undef(@CDEF);
my $e = 0;
my $unit = $ambsens->{units}->{$n};
foreach my $i (split(',', $ambsens->{desc}->{$n})) {
$i = trim($i);
$str = $ambsens->{map}->{$i} || $i;
if ($show_average) {
$str = sprintf("%-10s", substr($str, 0, 10));
push(@tmp, "LINE2:s" . ($e + 1) . $LC[$e] . ":$str");
push(@tmp, "GPRINT:s" . ($e + 1) . ":LAST: Cur\\:" . $value_format);
push(@tmp, "GPRINT:s" . ($e + 1) . ":AVERAGE:Avg\\:" . $value_format);
push(@tmp, "GPRINT:s" . ($e + 1) . ":MIN:Min\\:" . $value_format);
push(@tmp, "GPRINT:s" . ($e + 1) . ":MAX:Max\\:" . $value_format . "\\n");
}
else {
$str = sprintf("%-40s", substr($str, 0, 40));
push(@tmp, "LINE2:s" . ($e + 1) . $LC[$e] . ":$str");
push(@tmp, "GPRINT:s" . ($e + 1) . ":LAST: Current\\:" . $value_format . "\\n");
}
push(@tmpz, "LINE2:s" . ($e + 1) . $LC[$e] . ":$str");
$e++;
}
while($e < 9) {
push(@tmp, "COMMENT: \\n");
$e++;
}
if(lc($config->{show_gaps}) eq "y") {
push(@tmp, "AREA:wrongdata#$colors->{gap}:");
push(@tmpz, "AREA:wrongdata#$colors->{gap}:");
push(@CDEF, "CDEF:wrongdata=allvalues,UN,INF,UNKN,IF");
}
($width, $height) = split('x', $config->{graph_size}->{medium});
$str = substr(trim($sl[$n]), 0, 25);
$pic = $rrd{$version}->("$IMG_DIR" . "$IMG[$n]",
"--title=$str ($tf->{nwhen}$tf->{twhen})",
"--start=-$tf->{nwhen}$tf->{twhen}",
"--imgformat=$imgfmt_uc",
"--vertical-label=$unit",
"--width=$width",
"--height=$height",
@extra,
@riglim,
$zoom,
@{$cgi->{version12}},
@{$colors->{graph_colors}},
"DEF:s1=$rrd:ambsens" . $n . "_s1:AVERAGE",
"DEF:s2=$rrd:ambsens" . $n . "_s2:AVERAGE",
"DEF:s3=$rrd:ambsens" . $n . "_s3:AVERAGE",
"DEF:s4=$rrd:ambsens" . $n . "_s4:AVERAGE",
"DEF:s5=$rrd:ambsens" . $n . "_s5:AVERAGE",
"DEF:s6=$rrd:ambsens" . $n . "_s6:AVERAGE",
"DEF:s7=$rrd:ambsens" . $n . "_s7:AVERAGE",
"DEF:s8=$rrd:ambsens" . $n . "_s8:AVERAGE",
"DEF:s9=$rrd:ambsens" . $n . "_s9:AVERAGE",
"CDEF:allvalues=s1,s2,s3,s4,s5,s6,s7,s8,s9,+,+,+,+,+,+,+,+",
@CDEF,
@tmp);
$err = RRDs::error;
push(@output, "ERROR: while graphing $IMG_DIR" . "$IMG[$n]: $err\n") if $err;
if(lc($config->{enable_zoom}) eq "y") {
($width, $height) = split('x', $config->{graph_size}->{zoom});
$picz = $rrd{$version}->("$IMG_DIR" . "$IMGz[$n]",
"--title=$str ($tf->{nwhen}$tf->{twhen})",
"--start=-$tf->{nwhen}$tf->{twhen}",
"--imgformat=$imgfmt_uc",
"--vertical-label=$unit",
"--width=$width",
"--height=$height",
@full_size_mode,
@extra,
@riglim,
$zoom,
@{$cgi->{version12}},
@{$colors->{graph_colors}},
"DEF:s1=$rrd:ambsens" . $n . "_s1:AVERAGE",
"DEF:s2=$rrd:ambsens" . $n . "_s2:AVERAGE",
"DEF:s3=$rrd:ambsens" . $n . "_s3:AVERAGE",
"DEF:s4=$rrd:ambsens" . $n . "_s4:AVERAGE",
"DEF:s5=$rrd:ambsens" . $n . "_s5:AVERAGE",
"DEF:s6=$rrd:ambsens" . $n . "_s6:AVERAGE",
"DEF:s7=$rrd:ambsens" . $n . "_s7:AVERAGE",
"DEF:s8=$rrd:ambsens" . $n . "_s8:AVERAGE",
"DEF:s9=$rrd:ambsens" . $n . "_s9:AVERAGE",
"CDEF:allvalues=s1,s2,s3,s4,s5,s6,s7,s8,s9,+,+,+,+,+,+,+,+",
@CDEF,
@tmpz);
$err = RRDs::error;
push(@output, "ERROR: while graphing $IMG_DIR" . "$IMGz[$n]: $err\n") if $err;
}
if($title || ($silent =~ /imagetag/ && $graph =~ /ambsens$n/)) {
if(lc($config->{enable_zoom}) eq "y") {
if(lc($config->{disable_javascript_void}) eq "y") {
push(@output, " " . picz_a_element(config => $config, IMGz => $IMGz[$n], IMG => $IMG[$n]) . "\n");
} else {
if($version eq "new") {
$picz_width = $picz->{image_width} * $config->{global_zoom};
$picz_height = $picz->{image_height} * $config->{global_zoom};
} else {
$picz_width = $width + 115;
$picz_height = $height + 100;
}
push(@output, " " . picz_js_a_element(width => $picz_width, height => $picz_height, config => $config, IMGz => $IMGz[$n], IMG => $IMG[$n]) . "\n");
}
} else {
push(@output, " " . img_element(config => $config, IMG => $IMG[$n]) . "\n");
}
}
if($title) {
push(@output, " </td>\n");
}
$n++;
}
if($title) {
push(@output, " </tr>\n");
}
}
if($title) {
push(@output, main::graph_footer());
}
push(@output, " <br>\n");
return @output;
}
1;