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
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
|
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";
}
};
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 overwriten
# 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, "-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};
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;
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 discarge the first answer since the first is bound to be an outliner.",
},
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
},
});
}
1;
|
