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 pings = 5
27 # [...]
29 *** Targets ***
31 probe = basefork # if this should be the default probe
33 # [...]
35 + mytarget
37 # probe = basefork # if the default probe is something else
38 host = my.host
39 pings = 5
40
42 Not all pinger programs support testing multiple hosts in a single go
43 like fping(1). If the measurement takes long enough, there may be not
44 enough time perform all the tests in the time available. For example,
45 if the test takes 30 seconds, measuring ten hosts already fills up the
46 SmokePing default five minute step.
47 Thus, it may be necessary to do some of the tests concurrently. This
49 module defines the ping method that forks the requested number of
50 concurrent processes and calls the pingone method that derived classes
51 must provide.
52 The pingone method is called with one argument: a hash containing the
54 target that is to be measured. The contents of the hash are described
55 in Smokeping::probes::basevars(3pm).
56 The number of concurrent processes is determined by the probe-specific
58 variable `forks' and is 5 by default. If there are more targets than
59 this value, another round of forks is done after the first processes
60 are finished. This continues until all the targets have been tested.
61 The timeout in which each child has to finish is set to 5 seconds
63 multiplied by the maximum number of 'pings' of the targets. You can set
64 the base timeout differently if you want to, using the timeout property
65 of the probe in the master config file (this again will be multiplied
66 by the maximum number of pings). The probe itself can also provide
67 another default value if desired by modifying the _default value of the
68 timeout variable.
69 If the child isn't finished when the timeout occurs, it will be killed
71 along with any processes it has started.
72 The number of pings sent can be specified in the target-specific
74 variable 'pings'.
75
77 Supported probe-specific variables:
78 forks
80 Run this many concurrent processes at maximum
81 Example value: 5
83 Default value: 5
85 offset
87 If you run many probes concurrently you may want to prevent them
88 from hitting your network all at the same time. Using the probe-
89 specific offset parameter you can change the point in time when
90 each probe will be run. Offset is specified in % of total interval,
91 or alternatively as 'random', and the offset from the 'General'
92 section is used if nothing is specified here. Note that this does
93 NOT influence the rrds itself, it is just a matter of when data
94 acqusition is initiated. (This variable is only applicable if the
95 variable 'concurrentprobes' is set in the 'General' section.)
96 Example value: 50%
98 step
100 Duration of the base interval that this probe should use, if
101 different from the one specified in the 'Database' section. Note
102 that the step in the RRD files is fixed when they are originally
103 generated, and if you change the step parameter afterwards, you'll
104 have to delete the old RRD files or somehow convert them. (This
105 variable is only applicable if the variable 'concurrentprobes' is
106 set in the 'General' section.)
107 Example value: 300
109 timeout
111 How long a single 'ping' takes at maximum
112 Example value: 15
114 Default value: 5
116 Supported target-specific variables:
118 pings
120 How many pings should be sent to each target, if different from the
121 global value specified in the Database section. Note that the
122 number of pings in the RRD files is fixed when they are originally
123 generated, and if you change this parameter afterwards, you'll have
124 to delete the old RRD files or somehow convert them.
125 Example value: 5
127
129 Niko Tyni <ntyni@iki.fi>
130
132 Smokeping::probes::basevars, Smokeping::probes::EchoPing
1332.7.2 2020-01-30 Smokeping_probes_basefork(3)