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        # The following variables can be overridden in each target section
26        /^influx_.+/ = influx_location = In the basement
27
28        # [...]
29
30        *** Targets ***
31
32        probe = FPingContinuous # if this should be the default probe
33
34        # [...]
35
36        + mytarget
37        # probe = FPingContinuous # if the default probe is something else
38        host = my.host
39        /^influx_.+/ = influx_location = In the basement
40

DESCRIPTION

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

VARIABLES

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

AUTHORS

149       Steven Wilton <swilton@fluentit.com.au> Tobias Oetiker
150       <tobi@oetiker.ch>
151
152
153
1542.8.2                             2022-01-22Smokeping_probes_FPingContinuous(3)