1Smokeping_probes_base(3) SmokePing Smokeping_probes_base(3)
2
3
4
6 Smokeping::probes::base - Base Class for implementing SmokePing Probes
7
9 For the time being, please use the Smokeping::probes::FPing for
10 inspiration when implementing your own probes.
11
13 *** Probes ***
14
15 +base
16
17 offset = 50%
18 pings = 20
19 step = 300
20
21 # The following variables can be overridden in each target section
22 /^influx_.+/ = influx_location = In the basement
23
24 # [...]
25
26 *** Targets ***
27
28 probe = base # if this should be the default probe
29
30 # [...]
31
32 + mytarget
33 # probe = base # if the default probe is something else
34 host = my.host
35 /^influx_.+/ = influx_location = In the basement
36
38 Supported probe-specific variables:
39
40 offset
41 If you run many probes concurrently you may want to prevent them
42 from hitting your network all at the same time. Using the probe-
43 specific offset parameter you can change the point in time when
44 each probe will be run. Offset is specified in % of total interval,
45 or alternatively as 'random', and the offset from the 'General'
46 section is used if nothing is specified here. Note that this does
47 NOT influence the rrds itself, it is just a matter of when data
48 acquisition is initiated. (This variable is only applicable if the
49 variable 'concurrentprobes' is set in the 'General' section.)
50
51 Example value: 50%
52
53 pings
54 How many pings should be sent to each target, if different from the
55 global value specified in the Database section. Note that the
56 number of pings in the RRD files is fixed when they are originally
57 generated, and if you change this parameter afterwards, you'll have
58 to delete the old RRD files or somehow convert them.
59
60 Example value: 20
61
62 step
63 Duration of the base interval that this probe should use, if
64 different from the one specified in the 'Database' section. Note
65 that the step in the RRD files is fixed when they are originally
66 generated, and if you change the step parameter afterwards, you'll
67 have to delete the old RRD files or somehow convert them. (This
68 variable is only applicable if the variable 'concurrentprobes' is
69 set in the 'General' section.)
70
71 Example value: 300
72
74 Tobias Oetiker <tobi@oetiker.ch>
75
76
77
782.8.2 2023-07-22 Smokeping_probes_base(3)