Smokeping_probes_basevars(3)

1Smokeping_probes_basevars(3)       SmokePing      Smokeping_probes_basevars(3)
2
3
4

NAME

6       Smokeping::probes::basevars - Another Base Class for implementing
7       SmokePing Probes
8

OVERVIEW

10       Like Smokeping::probes::base, but supports host-specific variables for
11       the probe.
12

SYNOPSIS

14        *** Probes ***
15
16        +basevars
17
18        offset = 50%
19        pings = 20
20        step = 300
21
22        # The following variables can be overridden in each target section
23        /^influx_.+/ = influx_location = In the basement
24
25        # [...]
26
27        *** Targets ***
28
29        probe = basevars # if this should be the default probe
30
31        # [...]
32
33        + mytarget
34        # probe = basevars # if the default probe is something else
35        host = my.host
36        /^influx_.+/ = influx_location = In the basement
37

DESCRIPTION

39       Provides the method `targets' that returns a list of hashes.  The
40       hashes contain the entries:
41
42       addr
43           The address of the target.
44
45       vars
46           A hash containing variables defined in the corresponding config
47           section.
48
49       tree
50           The unique index that `probe::base' uses for targets.
51
52           There's also the method 'vars' that returns the above mentioned
53           hash corresponding to the 'tree' index parameter.
54

VARIABLES

56       Supported probe-specific variables:
57
58       offset
59           If you run many probes concurrently you may want to prevent them
60           from hitting your network all at the same time. Using the probe-
61           specific offset parameter you can change the point in time when
62           each probe will be run. Offset is specified in % of total interval,
63           or alternatively as 'random', and the offset from the 'General'
64           section is used if nothing is specified here. Note that this does
65           NOT influence the rrds itself, it is just a matter of when data
66           acquisition is initiated.  (This variable is only applicable if the
67           variable 'concurrentprobes' is set in the 'General' section.)
68
69           Example value: 50%
70
71       pings
72           How many pings should be sent to each target, if different from the
73           global value specified in the Database section. Note that the
74           number of pings in the RRD files is fixed when they are originally
75           generated, and if you change this parameter afterwards, you'll have
76           to delete the old RRD files or somehow convert them.
77
78           Example value: 20
79
80       step
81           Duration of the base interval that this probe should use, if
82           different from the one specified in the 'Database' section. Note
83           that the step in the RRD files is fixed when they are originally
84           generated, and if you change the step parameter afterwards, you'll
85           have to delete the old RRD files or somehow convert them. (This
86           variable is only applicable if the variable 'concurrentprobes' is
87           set in the 'General' section.)
88
89           Example value: 300
90

AUTHORS

92       Niko Tyni <ntyni@iki.fi>
93

BUGS

95       Uses `Smokeping::probes::base' internals too much to be a derived
96       class, but I didn't want to touch the base class directly.
97