commit
This commit is contained in:
root
286
lib/Smokeping/probes/FPing.pm
Normal file
286
lib/Smokeping/probes/FPing.pm
Normal file
@@ -0,0 +1,286 @@
|
||||
package Smokeping::probes::FPing;
|
||||
|
||||
=head1 301 Moved Permanently
|
||||
|
||||
This is a Smokeping probe module. Please use the command
|
||||
|
||||
C<smokeping -man Smokeping::probes::FPing>
|
||||
|
||||
to view the documentation or the command
|
||||
|
||||
C<smokeping -makepod Smokeping::probes::FPing>
|
||||
|
||||
to generate the POD document.
|
||||
|
||||
=cut
|
||||
|
||||
use strict;
|
||||
use base qw(Smokeping::probes::base);
|
||||
use IPC::Open3;
|
||||
use Symbol;
|
||||
use Carp;
|
||||
|
||||
sub pod_hash {
|
||||
return {
|
||||
name => <<DOC,
|
||||
Smokeping::probes::FPing - FPing Probe for SmokePing
|
||||
DOC
|
||||
description => <<DOC,
|
||||
Integrates FPing as a probe into smokeping. The variable B<binary> must
|
||||
point to your copy of the FPing program. If it is not installed on
|
||||
your system yet, you can get a slightly enhanced version from L<www.smokeping.org/pub>.
|
||||
|
||||
The (optional) B<packetsize> option lets you configure the packetsize for the pings sent.
|
||||
|
||||
Since version 3.3 fping sends its statistics to stdout. Set B<usestdout> to 'true'
|
||||
so make smokeping read stdout instead of stderr.
|
||||
|
||||
In B<blazemode>, FPing sends one more ping than requested, and discards
|
||||
the first RTT value returned as it's likely to be an outlier.
|
||||
|
||||
The FPing manpage has the following to say on this topic:
|
||||
|
||||
Number of bytes of ping data to send. The minimum size (normally 12) allows
|
||||
room for the data that fping needs to do its work (sequence number,
|
||||
timestamp). The reported received data size includes the IP header
|
||||
(normally 20 bytes) and ICMP header (8 bytes), so the minimum total size is
|
||||
40 bytes. Default is 56, as in ping. Maximum is the theoretical maximum IP
|
||||
datagram size (64K), though most systems limit this to a smaller,
|
||||
system-dependent number.
|
||||
|
||||
|
||||
DOC
|
||||
authors => <<'DOC',
|
||||
Tobias Oetiker <tobi@oetiker.ch>
|
||||
DOC
|
||||
}
|
||||
}
|
||||
|
||||
sub new($$$)
|
||||
{
|
||||
my $proto = shift;
|
||||
my $class = ref($proto) || $proto;
|
||||
my $self = $class->SUPER::new(@_);
|
||||
|
||||
# no need for this if we run as a cgi
|
||||
unless ( $ENV{SERVER_SOFTWARE} ) {
|
||||
my $binary = join(" ", $self->binary);
|
||||
my $testhost = $self->testhost;
|
||||
my $return = `$binary -C 1 $testhost 2>&1`;
|
||||
$self->{enable}{S} = (`$binary -h 2>&1` =~ /\s-S[,\s]/);
|
||||
$self->{enable}{O} = (`$binary -h 2>&1` =~ /\s-O[,\s]/);
|
||||
croak "ERROR: fping ('$binary -C 1 $testhost') could not be run: $return"
|
||||
if $return =~ m/not found/;
|
||||
croak "ERROR: FPing must be installed setuid root or it will not work\n"
|
||||
if $return =~ m/only.+root/;
|
||||
|
||||
if ($return =~ m/bytes, ([0-9.]+)\sms\s+.*\n.*\n.*:\s+([0-9.]+)/ and $1 > 0){
|
||||
$self->{pingfactor} = 1000 * $2/$1;
|
||||
if ($1 != $2){
|
||||
warn "### fping seems to report in ", $2/$1, " milliseconds (old version?)";
|
||||
}
|
||||
} else {
|
||||
$self->{pingfactor} = 1000; # Gives us a good-guess default
|
||||
warn "### assuming you are using an fping copy reporting in milliseconds\n";
|
||||
}
|
||||
|
||||
# fping only has -4 and -6 switches starting with 3.16 and the binary refuses
|
||||
# to run if the switches are passed in to older versions.
|
||||
$self->{enable}{proto} = (`$binary -v 2>&1` =~ /Version (3.1[6-9]|[4-9])/);
|
||||
};
|
||||
|
||||
return $self;
|
||||
}
|
||||
|
||||
sub ProbeDesc($){
|
||||
my $self = shift;
|
||||
my $bytes = $self->{properties}{packetsize}||56;
|
||||
return "ICMP Echo Pings ($bytes Bytes)";
|
||||
}
|
||||
|
||||
# derived class (ie. RemoteFPing) can override this
|
||||
sub binary {
|
||||
my $self = shift;
|
||||
return $self->{properties}{binary};
|
||||
}
|
||||
|
||||
# derived class (ie. FPing6) can override this
|
||||
sub testhost {
|
||||
return "localhost";
|
||||
}
|
||||
|
||||
sub ping ($){
|
||||
my $self = shift;
|
||||
# do NOT call superclass ... the ping method MUST be overridden
|
||||
|
||||
# increment the internal 'rounds' counter
|
||||
$self->increment_rounds_count;
|
||||
|
||||
my %upd;
|
||||
my $inh = gensym;
|
||||
my $outh = gensym;
|
||||
my $errh = gensym;
|
||||
# pinging nothing is pointless
|
||||
return unless @{$self->addresses};
|
||||
my @params = () ;
|
||||
push @params, "-$self->{properties}{protocol}" if $self->{properties}{protocol} and $self->{enable}{proto};
|
||||
push @params, "-b$self->{properties}{packetsize}" if $self->{properties}{packetsize};
|
||||
push @params, "-t" . int(1000 * $self->{properties}{timeout}) if $self->{properties}{timeout};
|
||||
push @params, "-i" . int(1000 * $self->{properties}{mininterval});
|
||||
push @params, "-p" . int(1000 * $self->{properties}{hostinterval}) if $self->{properties}{hostinterval};
|
||||
push @params, "--iface=$self->{properties}{interface}" if $self->{properties}{interface};
|
||||
if ($self->rounds_count == 1 and $self->{properties}{sourceaddress} and not $self->{enable}{S}){
|
||||
$self->do_log("WARNING: your fping binary doesn't support source address setting (-S), I will ignore any sourceaddress configurations - see http://bugs.debian.org/198486.");
|
||||
}
|
||||
push @params, "-S$self->{properties}{sourceaddress}" if $self->{properties}{sourceaddress} and $self->{enable}{S};
|
||||
|
||||
if ($self->rounds_count == 1 and $self->{properties}{tos} and not $self->{enable}{O}){
|
||||
$self->do_log("WARNING: your fping binary doesn't support type of service setting (-O), I will ignore any tos configurations.");
|
||||
}
|
||||
push @params, "-O$self->{properties}{tos}" if $self->{properties}{tos} and $self->{enable}{O};
|
||||
|
||||
my $pings = $self->pings;
|
||||
if (($self->{properties}{blazemode} || '') eq 'true'){
|
||||
$pings++;
|
||||
}
|
||||
my @cmd = (
|
||||
$self->binary,
|
||||
'-C', $pings, '-q','-B1','-r1',
|
||||
@params,
|
||||
@{$self->addresses});
|
||||
$self->do_debug("Executing @cmd");
|
||||
my $pid = open3($inh,$outh,$errh, @cmd);
|
||||
$self->{rtts}={};
|
||||
my $fh = ( $self->{properties}{usestdout} || '') eq 'true' ? $outh : $errh;
|
||||
while (<$fh>){
|
||||
chomp;
|
||||
$self->do_debug("Got fping output: '$_'");
|
||||
next unless /^\S+\s+:\s+[-\d\.]/; #filter out error messages from fping
|
||||
my @times = split /\s+/;
|
||||
my $ip = shift @times;
|
||||
next unless ':' eq shift @times; #drop the colon
|
||||
if (($self->{properties}{blazemode} || '') eq 'true'){
|
||||
shift @times;
|
||||
}
|
||||
@times = map {sprintf "%.10e", $_ / $self->{pingfactor}} sort {$a <=> $b} grep /^\d/, @times;
|
||||
map { $self->{rtts}{$_} = [@times] } @{$self->{addrlookup}{$ip}} ;
|
||||
}
|
||||
waitpid $pid,0;
|
||||
# Exit status (of fping) is
|
||||
# 0 if all the hosts are reachable,
|
||||
# 1 if some hosts were unreachable,
|
||||
# 2 if any IP addresses were not found,
|
||||
# 3 for invalid command line arguments, and
|
||||
# 4 for a system call failure.
|
||||
# Don't log 0 or 1 as an unreachable host is not unexpected for a monitoring software
|
||||
my $rc = $?;
|
||||
my $status = $rc >> 8;
|
||||
carp join(" ",@cmd) . " returned with exit code $rc. run with debug enabled to get more information" unless $status == 0 or $status == 1;
|
||||
close $inh;
|
||||
close $outh;
|
||||
close $errh;
|
||||
}
|
||||
|
||||
sub probevars {
|
||||
my $class = shift;
|
||||
return $class->_makevars($class->SUPER::probevars, {
|
||||
_mandatory => [ 'binary' ],
|
||||
binary => {
|
||||
_sub => sub {
|
||||
my ($val) = @_;
|
||||
return undef if $ENV{SERVER_SOFTWARE}; # don't check for fping presence in cgi mode
|
||||
return "ERROR: FPing 'binary' does not point to an executable"
|
||||
unless -f $val and -x _;
|
||||
return undef;
|
||||
},
|
||||
_doc => "The location of your fping binary.",
|
||||
_example => '/usr/bin/fping',
|
||||
},
|
||||
packetsize => {
|
||||
_re => '\d+',
|
||||
_example => 5000,
|
||||
_sub => sub {
|
||||
my ($val) = @_;
|
||||
return "ERROR: FPing packetsize must be between 12 and 64000"
|
||||
if ( $val < 12 or $val > 64000 );
|
||||
return undef;
|
||||
},
|
||||
_doc => "The ping packet size (in the range of 12-64000 bytes).",
|
||||
|
||||
},
|
||||
blazemode => {
|
||||
_re => '(true|false)',
|
||||
_example => 'true',
|
||||
_doc => "Send an extra ping and then discard the first answer since the first is bound to be an outlier.",
|
||||
|
||||
},
|
||||
protocol => {
|
||||
_re => '(4|6)',
|
||||
_example => '4',
|
||||
_doc => "Choose if the ping should use IPv4 or IPv6.",
|
||||
|
||||
},
|
||||
usestdout => {
|
||||
_re => '(true|false)',
|
||||
_example => 'true',
|
||||
_doc => "Listen for FPing output on stdout instead of stderr ... (version 3.3+ sends its statistics on stdout).",
|
||||
|
||||
},
|
||||
timeout => {
|
||||
_re => '(\d*\.)?\d+',
|
||||
_example => 1.5,
|
||||
_doc => <<DOC,
|
||||
The fping "-t" parameter, but in (possibly fractional) seconds rather than
|
||||
milliseconds, for consistency with other Smokeping probes. Note that as
|
||||
Smokeping uses the fping 'counting' mode (-C), this apparently only affects
|
||||
the last ping.
|
||||
DOC
|
||||
},
|
||||
hostinterval => {
|
||||
_re => '(\d*\.)?\d+',
|
||||
_example => 1.5,
|
||||
_doc => <<DOC,
|
||||
The fping "-p" parameter, but in (possibly fractional) seconds rather than
|
||||
milliseconds, for consistency with other Smokeping probes. From fping(1):
|
||||
|
||||
This parameter sets the time that fping waits between successive packets
|
||||
to an individual target.
|
||||
DOC
|
||||
},
|
||||
mininterval => {
|
||||
_re => '(\d*\.)?\d+',
|
||||
_example => .001,
|
||||
_default => .01,
|
||||
_doc => <<DOC,
|
||||
The fping "-i" parameter, but in (probably fractional) seconds rather than
|
||||
milliseconds, for consistency with other Smokeping probes. From fping(1):
|
||||
|
||||
The minimum amount of time between sending a ping packet to any target.
|
||||
DOC
|
||||
},
|
||||
sourceaddress => {
|
||||
_re => '\d+(\.\d+){3}',
|
||||
_example => '192.168.0.1',
|
||||
_doc => <<DOC,
|
||||
The fping "-S" parameter . From fping(1):
|
||||
|
||||
Set source address.
|
||||
DOC
|
||||
},
|
||||
tos => {
|
||||
_re => '\d+|0x[0-9a-zA-Z]+',
|
||||
_example => '0x20',
|
||||
_doc => <<DOC,
|
||||
Set the type of service (TOS) of outgoing ICMP packets.
|
||||
You need at laeast fping-2.4b2_to3-ipv6 for this to work. Find
|
||||
a copy on www.smokeping.org/pub.
|
||||
DOC
|
||||
},
|
||||
interface => {
|
||||
_example => 'eth0',
|
||||
_doc => "The name of the network interface to perform the ping on.",
|
||||
},
|
||||
});
|
||||
}
|
||||
|
||||
1;
|
||||
Reference in New Issue
Block a user