Smokeping_probes_FPingContinuous(3)

1Smokeping_probes_FPingContinuous(3)SmokePingSmokeping_probes_FPingContinuous(3)
2
3
4

NAME

6       Smokeping::probes::FPingContinuous - FPingContinuous Probe for
7       SmokePing
8

SYNOPSIS

10        *** Probes ***
11
12        +FPingContinuous
13
14        binary = /usr/bin/fping # mandatory
15        hostinterval = 1.5
16        offset = 50%
17        packetsize = 5000
18        pings = 20
19        sourceaddress = 192.168.0.1
20        step = 300
21        timeout = 1.5
22        tos = 0x20
23        usestdout = false
24
25        # [...]
26
27        *** Targets ***
28
29        probe = FPingContinuous # if this should be the default probe
30
31        # [...]
32
33        + mytarget
34        # probe = FPingContinuous # if the default probe is something else
35        host = my.host
36

DESCRIPTION

38       Integrates FPingContinuous as a probe into smokeping. The variable
39       binary must point to your copy of the FPing program.  If it is not
40       installed on your system yet, you can get a slightly enhanced version
41       from "pub" in www.smokeping.org.
42
43       The (optional) packetsize option lets you configure the packetsize for
44       the pings sent.
45
46       Continuous output is normally sent to stdout, but you can set usestdout
47       to 'false' to make smokeping read stderr instead of stdout.
48
49       The FPing manpage has the following to say on this topic:
50
51       Number of bytes of ping data to send.  The minimum size (normally 12)
52       allows room for the data that fping needs to do its work (sequence
53       number, timestamp).  The reported received data size includes the IP
54       header (normally 20 bytes) and ICMP header (8 bytes), so the minimum
55       total size is 40 bytes.  Default is 56, as in ping. Maximum is the
56       theoretical maximum IP datagram size (64K), though most systems limit
57       this to a smaller, system-dependent number.
58

VARIABLES

60       Supported probe-specific variables:
61
62       binary
63           The location of your fping binary.
64
65           Example value: /usr/bin/fping
66
67           This setting is mandatory.
68
69       hostinterval
70           The fping "-p" parameter, but in (possibly fractional) seconds
71           rather than milliseconds, for consistency with other Smokeping
72           probes. From fping(1):
73
74           This parameter sets the time that fping  waits between successive
75           packets to an individual target.
76
77           Example value: 1.5
78
79       offset
80           If you run many probes concurrently you may want to prevent them
81           from hitting your network all at the same time. Using the probe-
82           specific offset parameter you can change the point in time when
83           each probe will be run. Offset is specified in % of total interval,
84           or alternatively as 'random', and the offset from the 'General'
85           section is used if nothing is specified here. Note that this does
86           NOT influence the rrds itself, it is just a matter of when data
87           acqusition is initiated.  (This variable is only applicable if the
88           variable 'concurrentprobes' is set in the 'General' section.)
89
90           Example value: 50%
91
92       packetsize
93           The ping packet size (in the range of 12-64000 bytes).
94
95           Example value: 5000
96
97       pings
98           How many pings should be sent to each target, if different from the
99           global value specified in the Database section. Note that the
100           number of pings in the RRD files is fixed when they are originally
101           generated, and if you change this parameter afterwards, you'll have
102           to delete the old RRD files or somehow convert them.
103
104           Example value: 20
105
106       sourceaddress
107           The fping "-S" parameter . From fping(1):
108
109           Set source address.
110
111           Example value: 192.168.0.1
112
113       step
114           Duration of the base interval that this probe should use, if
115           different from the one specified in the 'Database' section. Note
116           that the step in the RRD files is fixed when they are originally
117           generated, and if you change the step parameter afterwards, you'll
118           have to delete the old RRD files or somehow convert them. (This
119           variable is only applicable if the variable 'concurrentprobes' is
120           set in the 'General' section.)
121
122           Example value: 300
123
124       timeout
125           The fping "-t" parameter, but in (possibly fractional) seconds
126           rather than milliseconds, for consistency with other Smokeping
127           probes. Note that as Smokeping uses the fping 'counting' mode (-C),
128           this apparently only affects the last ping.
129
130           Example value: 1.5
131
132       tos Set the type of service (TOS) of outgoing ICMP packets.  You need
133           at laeast fping-2.4b2_to3-ipv6 for this to work. Find a copy on
134           www.smokeping.org/pub.
135
136           Example value: 0x20
137
138       usestdout
139           Listen for FPing output on stdout instead of stderr ... (continuous
140           output is normally sent to stdout).
141
142           Example value: false
143

AUTHORS

145       Steven Wilton <swilton@fluentit.com.au> Tobias Oetiker
146       <tobi@oetiker.ch>
147
148
149
1502.7.3                             2021-07-23Smokeping_probes_FPingContinuous(3)