1Smokeping_probes_FPing(3)          SmokePing         Smokeping_probes_FPing(3)
2
3
4

NAME

6       Smokeping::probes::FPing - FPing Probe for SmokePing
7

SYNOPSIS

9        *** Probes ***
10
11        +FPing
12
13        binary = /usr/bin/fping # 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        sourceaddress = 192.168.0.1
23        step = 300
24        timeout = 1.5
25        tos = 0x20
26        usestdout = true
27
28        # The following variables can be overridden in each target section
29        /^influx_.+/ = influx_location = In the basement
30
31        # [...]
32
33        *** Targets ***
34
35        probe = FPing # if this should be the default probe
36
37        # [...]
38
39        + mytarget
40        # probe = FPing # if the default probe is something else
41        host = my.host
42        /^influx_.+/ = influx_location = In the basement
43

DESCRIPTION

45       Integrates FPing as a probe into smokeping. The variable binary must
46       point to your copy of the FPing program.  If it is not installed on
47       your system yet, you can get a slightly enhanced version from "pub" in
48       www.smokeping.org.
49
50       The (optional) packetsize option lets you configure the packetsize for
51       the pings sent.
52
53       Since version 3.3 fping sends its statistics to stdout. Set usestdout
54       to 'true' so make smokeping read stdout instead of stderr.
55
56       In blazemode, FPing sends one more ping than requested, and discards
57       the first RTT value returned as it's likely to be an outlier.
58
59       The FPing manpage has the following to say on this topic:
60
61       Number of bytes of ping data to send.  The minimum size (normally 12)
62       allows room for the data that fping needs to do its work (sequence
63       number, timestamp).  The reported received data size includes the IP
64       header (normally 20 bytes) and ICMP header (8 bytes), so the minimum
65       total size is 40 bytes.  Default is 56, as in ping. Maximum is the
66       theoretical maximum IP datagram size (64K), though most systems limit
67       this to a smaller, system-dependent number.
68

VARIABLES

70       Supported probe-specific variables:
71
72       binary
73           The location of your fping binary.
74
75           Example value: /usr/bin/fping
76
77           This setting is mandatory.
78
79       blazemode
80           Send an extra ping and then discard the first answer since the
81           first is bound to be an outlier.
82
83           Example value: true
84
85       hostinterval
86           The fping "-p" parameter, but in (possibly fractional) seconds
87           rather than milliseconds, for consistency with other Smokeping
88           probes. From fping(1):
89
90           This parameter sets the time that fping  waits between successive
91           packets to an individual target.
92
93           Example value: 1.5
94
95       interface
96           The name of the network interface to perform the ping on.
97
98           Example value: eth0
99
100       mininterval
101           The fping "-i" parameter, but in (probably fractional) seconds
102           rather than milliseconds, for consistency with other Smokeping
103           probes. From fping(1):
104
105           The minimum amount of time between sending a ping packet to any
106           target.
107
108           Example value: 0.001
109
110           Default value: 0.01
111
112       offset
113           If you run many probes concurrently you may want to prevent them
114           from hitting your network all at the same time. Using the probe-
115           specific offset parameter you can change the point in time when
116           each probe will be run. Offset is specified in % of total interval,
117           or alternatively as 'random', and the offset from the 'General'
118           section is used if nothing is specified here. Note that this does
119           NOT influence the rrds itself, it is just a matter of when data
120           acquisition is initiated.  (This variable is only applicable if the
121           variable 'concurrentprobes' is set in the 'General' section.)
122
123           Example value: 50%
124
125       packetsize
126           The ping packet size (in the range of 12-64000 bytes).
127
128           Example value: 5000
129
130       pings
131           How many pings should be sent to each target, if different from the
132           global value specified in the Database section. Note that the
133           number of pings in the RRD files is fixed when they are originally
134           generated, and if you change this parameter afterwards, you'll have
135           to delete the old RRD files or somehow convert them.
136
137           Example value: 20
138
139       protocol
140           Choose if the ping should use IPv4 or IPv6.
141
142           Example value: 4
143
144       sourceaddress
145           The fping "-S" parameter . From fping(1):
146
147           Set source address.
148
149           Example value: 192.168.0.1
150
151       step
152           Duration of the base interval that this probe should use, if
153           different from the one specified in the 'Database' section. Note
154           that the step in the RRD files is fixed when they are originally
155           generated, and if you change the step parameter afterwards, you'll
156           have to delete the old RRD files or somehow convert them. (This
157           variable is only applicable if the variable 'concurrentprobes' is
158           set in the 'General' section.)
159
160           Example value: 300
161
162       timeout
163           The fping "-t" parameter, but in (possibly fractional) seconds
164           rather than milliseconds, for consistency with other Smokeping
165           probes. Note that as Smokeping uses the fping 'counting' mode (-C),
166           this apparently only affects the last ping.
167
168           Example value: 1.5
169
170       tos Set the type of service (TOS) of outgoing ICMP packets.  You need
171           at laeast fping-2.4b2_to3-ipv6 for this to work. Find a copy on
172           www.smokeping.org/pub.
173
174           Example value: 0x20
175
176       usestdout
177           Listen for FPing output on stdout instead of stderr ... (version
178           3.3+ sends its statistics on stdout).
179
180           Example value: true
181

AUTHORS

183       Tobias Oetiker <tobi@oetiker.ch>
184
185
186
1872.8.2                             2022-07-23         Smokeping_probes_FPing(3)
Impressum