1Smokeping_probes_FPing(3) SmokePing Smokeping_probes_FPing(3)
2
3
4
6 Smokeping::probes::FPing - FPing Probe for SmokePing
7
9 *** Probes ***
10
11 +FPing
12
13 binary = /usr/bin/fping # mandatory
14 blazemode = true
15 hostinterval = 1.5
16 mininterval = 0.001
17 offset = 50%
18 packetsize = 5000
19 pings = 20
20 protocol = 4
21 sourceaddress = 192.168.0.1
22 step = 300
23 timeout = 1.5
24 tos = 0x20
25 usestdout = true
26
27 # [...]
28
29 *** Targets ***
30
31 probe = FPing # if this should be the default probe
32
33 # [...]
34
35 + mytarget
36 # probe = FPing # if the default probe is something else
37 host = my.host
38
40 Integrates FPing as a probe into smokeping. The variable binary must
41 point to your copy of the FPing program. If it is not installed on
42 your system yet, you can get a slightly enhanced version from "pub" in
43 www.smokeping.org.
44
45 The (optional) packetsize option lets you configure the packetsize for
46 the pings sent.
47
48 Since version 3.3 fping sends its statistics to stdout. Set usestdout
49 to 'true' so make smokeping read stdout instead of stderr.
50
51 In blazemode, FPing sends one more ping than requested, and discards
52 the first RTT value returned as it's likely to be an outlier.
53
54 The FPing manpage has the following to say on this topic:
55
56 Number of bytes of ping data to send. The minimum size (normally 12)
57 allows room for the data that fping needs to do its work (sequence
58 number, timestamp). The reported received data size includes the IP
59 header (normally 20 bytes) and ICMP header (8 bytes), so the minimum
60 total size is 40 bytes. Default is 56, as in ping. Maximum is the
61 theoretical maximum IP datagram size (64K), though most systems limit
62 this to a smaller, system-dependent number.
63
65 Supported probe-specific variables:
66
67 binary
68 The location of your fping binary.
69
70 Example value: /usr/bin/fping
71
72 This setting is mandatory.
73
74 blazemode
75 Send an extra ping and then discarge the first answer since the
76 first is bound to be an outliner.
77
78 Example value: true
79
80 hostinterval
81 The fping "-p" parameter, but in (possibly fractional) seconds
82 rather than milliseconds, for consistency with other Smokeping
83 probes. From fping(1):
84
85 This parameter sets the time that fping waits between successive
86 packets to an individual target.
87
88 Example value: 1.5
89
90 mininterval
91 The fping "-i" parameter, but in (probably fractional) seconds
92 rather than milliseconds, for consistency with other Smokeping
93 probes. From fping(1):
94
95 The minimum amount of time between sending a ping packet to any
96 target.
97
98 Example value: 0.001
99
100 Default value: 0.01
101
102 offset
103 If you run many probes concurrently you may want to prevent them
104 from hitting your network all at the same time. Using the probe-
105 specific offset parameter you can change the point in time when
106 each probe will be run. Offset is specified in % of total interval,
107 or alternatively as 'random', and the offset from the 'General'
108 section is used if nothing is specified here. Note that this does
109 NOT influence the rrds itself, it is just a matter of when data
110 acqusition is initiated. (This variable is only applicable if the
111 variable 'concurrentprobes' is set in the 'General' section.)
112
113 Example value: 50%
114
115 packetsize
116 The ping packet size (in the range of 12-64000 bytes).
117
118 Example value: 5000
119
120 pings
121 How many pings should be sent to each target, if different from the
122 global value specified in the Database section. Note that the
123 number of pings in the RRD files is fixed when they are originally
124 generated, and if you change this parameter afterwards, you'll have
125 to delete the old RRD files or somehow convert them.
126
127 Example value: 20
128
129 protocol
130 Choose if the ping should use IPv4 or IPv6.
131
132 Example value: 4
133
134 Default value: 4
135
136 sourceaddress
137 The fping "-S" parameter . From fping(1):
138
139 Set source address.
140
141 Example value: 192.168.0.1
142
143 step
144 Duration of the base interval that this probe should use, if
145 different from the one specified in the 'Database' section. Note
146 that the step in the RRD files is fixed when they are originally
147 generated, and if you change the step parameter afterwards, you'll
148 have to delete the old RRD files or somehow convert them. (This
149 variable is only applicable if the variable 'concurrentprobes' is
150 set in the 'General' section.)
151
152 Example value: 300
153
154 timeout
155 The fping "-t" parameter, but in (possibly fractional) seconds
156 rather than milliseconds, for consistency with other Smokeping
157 probes. Note that as Smokeping uses the fping 'counting' mode (-C),
158 this apparently only affects the last ping.
159
160 Example value: 1.5
161
162 tos Set the type of service (TOS) of outgoing ICMP packets. You need
163 at laeast fping-2.4b2_to3-ipv6 for this to work. Find a copy on
164 www.smokeping.org/pub.
165
166 Example value: 0x20
167
168 usestdout
169 Listen for FPing output on stdout instead of stderr ... (version
170 3.3+ sends its statistics on stdout).
171
172 Example value: true
173
175 Tobias Oetiker <tobi@oetiker.ch>
176
177
178
1792.7.3 2021-07-23 Smokeping_probes_FPing(3)