1Smokeping_probes_basefork(3) SmokePing Smokeping_probes_basefork(3)
2
6 Smokeping::probes::basefork - Yet Another Base Class for implementing
7 SmokePing Probes
8
10 Like Smokeping::probes::basevars, but supports the probe-specific
11 property `forks' to determine how many processes should be run
12 concurrently. The targets are pinged one at a time, and the number of
13 pings sent can vary between targets.
14
16 *** Probes ***
17 +basefork
19 forks = 5
21 offset = 50%
22 step = 300
23 timeout = 15
24 # The following variables can be overridden in each target section
26 /^influx_.+/ = influx_location = In the basement
27 pings = 5
28 # [...]
30 *** Targets ***
32 probe = basefork # if this should be the default probe
34 # [...]
36 + mytarget
38 # probe = basefork # if the default probe is something else
39 host = my.host
40 /^influx_.+/ = influx_location = In the basement
41 pings = 5
42
44 Not all pinger programs support testing multiple hosts in a single go
45 like fping(1). If the measurement takes long enough, there may be not
46 enough time perform all the tests in the time available. For example,
47 if the test takes 30 seconds, measuring ten hosts already fills up the
48 SmokePing default five minute step.
49 Thus, it may be necessary to do some of the tests concurrently. This
51 module defines the ping method that forks the requested number of
52 concurrent processes and calls the pingone method that derived classes
53 must provide.
54 The pingone method is called with one argument: a hash containing the
56 target that is to be measured. The contents of the hash are described
57 in Smokeping::probes::basevars(3pm).
58 The number of concurrent processes is determined by the probe-specific
60 variable `forks' and is 5 by default. If there are more targets than
61 this value, another round of forks is done after the first processes
62 are finished. This continues until all the targets have been tested.
63 The timeout in which each child has to finish is set to 5 seconds
65 multiplied by the maximum number of 'pings' of the targets. You can set
66 the base timeout differently if you want to, using the timeout property
67 of the probe in the master config file (this again will be multiplied
68 by the maximum number of pings). The probe itself can also provide
69 another default value if desired by modifying the _default value of the
70 timeout variable.
71 If the child isn't finished when the timeout occurs, it will be killed
73 along with any processes it has started.
74 The number of pings sent can be specified in the target-specific
76 variable 'pings'.
77
79 Supported probe-specific variables:
80 forks
82 Run this many concurrent processes at maximum
83 Example value: 5
85 Default value: 5
87 offset
89 If you run many probes concurrently you may want to prevent them
90 from hitting your network all at the same time. Using the probe-
91 specific offset parameter you can change the point in time when
92 each probe will be run. Offset is specified in % of total interval,
93 or alternatively as 'random', and the offset from the 'General'
94 section is used if nothing is specified here. Note that this does
95 NOT influence the rrds itself, it is just a matter of when data
96 acquisition is initiated. (This variable is only applicable if the
97 variable 'concurrentprobes' is set in the 'General' section.)
98 Example value: 50%
100 step
102 Duration of the base interval that this probe should use, if
103 different from the one specified in the 'Database' section. Note
104 that the step in the RRD files is fixed when they are originally
105 generated, and if you change the step parameter afterwards, you'll
106 have to delete the old RRD files or somehow convert them. (This
107 variable is only applicable if the variable 'concurrentprobes' is
108 set in the 'General' section.)
109 Example value: 300
111 timeout
113 How long a single 'ping' takes at maximum
114 Example value: 15
116 Default value: 5
118 Supported target-specific variables:
120 /^influx_.+/
122 This is a tag that will be sent to influxdb and has no impact on
123 the probe measurement. The tag name will be sent without the
124 "influx_" prefix, which will be replaced with "tag_" instead. Tags
125 can be used for filtering.
126 Example value: influx_location = In the basement
128 pings
130 How many pings should be sent to each target, if different from the
131 global value specified in the Database section. Note that the
132 number of pings in the RRD files is fixed when they are originally
133 generated, and if you change this parameter afterwards, you'll have
134 to delete the old RRD files or somehow convert them.
135 Example value: 5
137
139 Niko Tyni <ntyni@iki.fi>
140
142 Smokeping::probes::basevars, Smokeping::probes::EchoPing
1432.8.2 2022-07-23 Smokeping_probes_basefork(3)