1Smokeping_probes_skel(3)           SmokePing          Smokeping_probes_skel(3)
2
3
4

NAME

6       Smokeping::probes::skel - a skeleton for Smokeping Probes
7

SYNOPSIS

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

DESCRIPTION

37       This is a non-functional module that is intended to act as a basis for
38       creation of new probes. See the smokeping_extend document for more
39       information.
40

VARIABLES

42       Supported probe-specific variables:
43
44       forks
45           Run this many concurrent processes at maximum
46
47           Example value: 5
48
49           Default value: 5
50
51       offset
52           If you run many probes concurrently you may want to prevent them
53           from hitting your network all at the same time. Using the probe-
54           specific offset parameter you can change the point in time when
55           each probe will be run. Offset is specified in % of total interval,
56           or alternatively as 'random', and the offset from the 'General'
57           section is used if nothing is specified here. Note that this does
58           NOT influence the rrds itself, it is just a matter of when data
59           acquisition is initiated.  (This variable is only applicable if the
60           variable 'concurrentprobes' is set in the 'General' section.)
61
62           Example value: 50%
63
64       step
65           Duration of the base interval that this probe should use, if
66           different from the one specified in the 'Database' section. Note
67           that the step in the RRD files is fixed when they are originally
68           generated, and if you change the step parameter afterwards, you'll
69           have to delete the old RRD files or somehow convert them. (This
70           variable is only applicable if the variable 'concurrentprobes' is
71           set in the 'General' section.)
72
73           Example value: 300
74
75       timeout
76           How long a single 'ping' takes at maximum
77
78           Example value: 15
79
80           Default value: 5
81
82       Supported target-specific variables:
83
84       /^influx_.+/
85           This is a tag that will be sent to influxdb and has no impact on
86           the probe measurement. The tag name will be sent without the
87           "influx_" prefix, which will be replaced with "tag_" instead. Tags
88           can be used for filtering.
89
90           Example value: influx_location = In the basement
91
92       pings
93           How many pings should be sent to each target, if different from the
94           global value specified in the Database section. Note that the
95           number of pings in the RRD files is fixed when they are originally
96           generated, and if you change this parameter afterwards, you'll have
97           to delete the old RRD files or somehow convert them.
98
99           Example value: 5
100

AUTHORS

102        Niko Tyni <ntyni@iki.fi>,
103

SEE ALSO

105       smokeping_extend
106
107
108
1092.8.2                             2023-07-22          Smokeping_probes_skel(3)
Impressum