pve-manager/PVE/Status/Graphite.pm
Dominik Csapak 5a5aed73e2 fix #1683: do not send non-numeric values to graphite
the graphite daemons which accept the data (carbon), only
accepts numeric values, and logs all invalid lines

since that were about 5 values per vm/ct this generated lot of noise
in the carbon log

so we check with a regex if a value is numeric, and
additionally we have a blacklist of keys which seem to be numeric but
are either boolean (e.g. template) or a state (e.g. pid)

Signed-off-by: Dominik Csapak <d.csapak@proxmox.com>
2018-03-05 14:21:50 +01:00

131 lines
3.0 KiB
Perl

package PVE::Status::Graphite;
use strict;
use warnings;
use PVE::Status::Plugin;
# example config (/etc/pve/status.cfg)
#graphite:
# server test
# port 2003
# path proxmox.mycluster
# disable 0
#
use base('PVE::Status::Plugin');
sub type {
return 'graphite';
}
sub properties {
return {
path => {
type => 'string', format => 'graphite-path',
description => "root graphite path (ex: proxmox.mycluster.mykey)",
},
};
}
sub options {
return {
server => {},
port => { optional => 1 },
path => { optional => 1 },
disable => { optional => 1 },
};
}
# we do not want boolean/state information to export to graphite
my $key_blacklist = {
'template' => 1,
'pid' => 1,
'agent' => 1,
'serial' => 1,
};
# Plugin implementation
sub update_node_status {
my ($class, $plugin_config, $node, $data, $ctime) = @_;
write_graphite_hash($plugin_config, $data, $ctime, "nodes.$node");
}
sub update_qemu_status {
my ($class, $plugin_config, $vmid, $data, $ctime, $nodename) = @_;
write_graphite_hash($plugin_config, $data, $ctime, "qemu.$vmid");
}
sub update_lxc_status {
my ($class, $plugin_config, $vmid, $data, $ctime, $nodename) = @_;
write_graphite_hash($plugin_config, $data, $ctime, "lxc.$vmid");
}
sub update_storage_status {
my ($class, $plugin_config, $nodename, $storeid, $data, $ctime) = @_;
write_graphite_hash($plugin_config, $data, $ctime, "storages.$nodename.$storeid");
}
sub write_graphite_hash {
my ($plugin_config, $d, $ctime, $object) = @_;
my $host = $plugin_config->{server};
my $port = $plugin_config->{port} ? $plugin_config->{port} : 2003;
my $path = $plugin_config->{path} ? $plugin_config->{path} : 'proxmox';
my $carbon_socket = IO::Socket::IP->new(
PeerAddr => $host,
PeerPort => $port,
Proto => 'udp',
) || die "couldn't create carbon socket [$host]:$port - $@\n";
write_graphite($carbon_socket, $d, $ctime, $path.".$object");
$carbon_socket->close() if $carbon_socket;
}
sub write_graphite {
my ($carbon_socket, $d, $ctime, $path) = @_;
for my $key (keys %$d) {
my $value = $d->{$key};
my $oldpath = $path;
$key =~ s/\./-/g;
$path .= ".$key";
if ( defined $value ) {
if ( ref $value eq 'HASH' ) {
write_graphite($carbon_socket, $value, $ctime, $path);
} elsif ($value =~ m/^[+-]?[0-9]*\.?[0-9]+$/ &&
!$key_blacklist->{$key}) {
$carbon_socket->send( "$path $value $ctime\n" );
} else {
# do not send blacklisted or non-numeric values
}
}
$path = $oldpath;
}
}
PVE::JSONSchema::register_format('graphite-path', \&pve_verify_graphite_path);
sub pve_verify_graphite_path {
my ($path, $noerr) = @_;
my $regex = "([a-zA-Z0-9]([a-zA-Z0-9\-]*[a-zA-Z0-9])?)";
if ($path !~ /^(${regex}\.)*${regex}$/) {
return undef if $noerr;
die "value does not look like a valid graphite path\n";
}
return $path;
}
1;