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        # [...]
23
24        *** Targets ***
25
26        probe = basevars # if this should be the default probe
27
28        # [...]
29
30        + mytarget
31        # probe = basevars # if the default probe is something else
32        host = my.host
33

DESCRIPTION

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

VARIABLES

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

AUTHORS

88       Niko Tyni <ntyni@iki.fi>
89

BUGS

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