1Smokeping_probes_RemoteFPing(3) SmokePing Smokeping_probes_RemoteFPing(3)
2
6 Smokeping::probes::RemoteFPing - Remote FPing Probe for SmokePing
7
9 *** Probes ***
10 +RemoteFPing
12 binary = /usr/bin/ssh # mandatory
14 blazemode = true
15 hostinterval = 1.5
16 interface = eth0
17 mininterval = 0.001
18 offset = 50%
19 packetsize = 5000
20 pings = 20
21 protocol = 4
22 rbinary = /usr/bin/fping # mandatory
23 rhost = my.pinger.host # mandatory
24 rport = 22
25 ruser = foo
26 sourceaddress = 192.168.0.1
27 step = 300
28 timeout = 1.5
29 tos = 0x20
30 usestdout = true
31 # The following variables can be overridden in each target section
33 /^influx_.+/ = influx_location = In the basement
34 # [...]
36 *** Targets ***
38 probe = RemoteFPing # if this should be the default probe
40 # [...]
42 + mytarget
44 # probe = RemoteFPing # if the default probe is something else
45 host = my.host
46 /^influx_.+/ = influx_location = In the basement
47
49 Integrates the remote execution of FPing via ssh/rsh into smokeping.
50 The variable binary must point to your copy of the ssh/rsh program.
51 The variable rbinary must point to your copy of the fping program at
52 the remote end.
53
55 Supported probe-specific variables:
56 binary
58 This variable specifies the path of the remote shell program
59 (usually ssh, rsh or remsh). Any other script or binary that can be
60 called as
61 binary [ -l ruser ] [ -p rport ] rhost rbinary
63 may be used.
65 Example value: /usr/bin/ssh
67 This setting is mandatory.
69 blazemode
71 Send an extra ping and then discard the first answer since the
72 first is bound to be an outlier.
73 Example value: true
75 hostinterval
77 The fping "-p" parameter, but in (possibly fractional) seconds
78 rather than milliseconds, for consistency with other Smokeping
79 probes. From fping(1):
80 This parameter sets the time that fping waits between successive
82 packets to an individual target.
83 Example value: 1.5
85 interface
87 The name of the network interface to perform the ping on.
88 Example value: eth0
90 mininterval
92 The fping "-i" parameter, but in (probably fractional) seconds
93 rather than milliseconds, for consistency with other Smokeping
94 probes. From fping(1):
95 The minimum amount of time between sending a ping packet to any
97 target.
98 Example value: 0.001
100 Default value: 0.01
102 offset
104 If you run many probes concurrently you may want to prevent them
105 from hitting your network all at the same time. Using the probe-
106 specific offset parameter you can change the point in time when
107 each probe will be run. Offset is specified in % of total interval,
108 or alternatively as 'random', and the offset from the 'General'
109 section is used if nothing is specified here. Note that this does
110 NOT influence the rrds itself, it is just a matter of when data
111 acquisition is initiated. (This variable is only applicable if the
112 variable 'concurrentprobes' is set in the 'General' section.)
113 Example value: 50%
115 packetsize
117 The ping packet size (in the range of 12-64000 bytes).
118 Example value: 5000
120 pings
122 How many pings should be sent to each target, if different from the
123 global value specified in the Database section. Note that the
124 number of pings in the RRD files is fixed when they are originally
125 generated, and if you change this parameter afterwards, you'll have
126 to delete the old RRD files or somehow convert them.
127 Example value: 20
129 protocol
131 Choose if the ping should use IPv4 or IPv6.
132 Example value: 4
134 rbinary
136 The location of your fping binary.
137 Example value: /usr/bin/fping
139 This setting is mandatory.
141 rhost
143 The rhost option specifies the remote device from where fping will
144 be launched.
145 Example value: my.pinger.host
147 This setting is mandatory.
149 rport
151 The (optional) rport option allows you to specify the port of the
152 remote host.
153 Example value: 22
155 ruser
157 The (optional) ruser option allows you to specify the remote user,
158 if different from the one running the smokeping daemon.
159 Example value: foo
161 sourceaddress
163 The fping "-S" parameter . From fping(1):
164 Set source address.
166 Example value: 192.168.0.1
168 step
170 Duration of the base interval that this probe should use, if
171 different from the one specified in the 'Database' section. Note
172 that the step in the RRD files is fixed when they are originally
173 generated, and if you change the step parameter afterwards, you'll
174 have to delete the old RRD files or somehow convert them. (This
175 variable is only applicable if the variable 'concurrentprobes' is
176 set in the 'General' section.)
177 Example value: 300
179 timeout
181 The fping "-t" parameter, but in (possibly fractional) seconds
182 rather than milliseconds, for consistency with other Smokeping
183 probes. Note that as Smokeping uses the fping 'counting' mode (-C),
184 this apparently only affects the last ping.
185 Example value: 1.5
187 tos Set the type of service (TOS) of outgoing ICMP packets. You need
189 at laeast fping-2.4b2_to3-ipv6 for this to work. Find a copy on
190 www.smokeping.org/pub.
191 Example value: 0x20
193 usestdout
195 Listen for FPing output on stdout instead of stderr ... (version
196 3.3+ sends its statistics on stdout).
197 Example value: true
199
201 Luis F Balbinot <hades@inf.ufrgs.br>
202 Niko Tyni <ntyni@iki.fi>
204 derived from Smokeping::probes::FPing by
206 Tobias Oetiker <tobi@oetiker.ch>
208
210 It is important to make sure that you can access the remote machine
211 without a password prompt, otherwise this probe will not work properly.
212 To test just try something like this:
213 $ ssh foo@HostA.foobar.com fping HostB.barfoo.com
215 The next thing you see must be fping's output.
217 The rhost, ruser, rport and rbinary variables used to be configured in
219 the Targets section of the first target or its parents They were moved
220 to the Probes section, because the variables aren't really target-
221 specific (all the targets are measured with the same parameters). The
222 Targets sections aren't recognized anymore.
223
225 This functionality should be in a generic 'remote execution' module so
226 that it could be used for the other probes too.
2272.8.2 2023-01-21 Smokeping_probes_RemoteFPing(3)