Smokeping_probes_EchoPingPlugin(3)

1Smokeping_probes_EchoPingPlugin(3) SmokePingSmokeping_probes_EchoPingPlugin(3)
2
3
4

NAME

6       Smokeping::probes::EchoPingPlugin - a basis for using echoping(1)
7       plugins as probes for SmokePing
8

OVERVIEW

10       Measures roundtrip times for SmokePing with an echoping(1) plugin. The
11       plugins currently shipped with echoping are implemented as separate
12       probes based on this class, but the class can also be used directly.
13

SYNOPSIS

15        *** Probes ***
16
17        +EchoPingPlugin
18
19        binary = /usr/bin/echoping
20        forks = 5
21        offset = 50%
22        step = 300
23
24        # The following variables can be overridden in each target section
25        /^influx_.+/ = influx_location = In the basement
26        extraopts = -some-letter-the-author-did-not-think-of
27        ipversion = 4
28        pings = 5
29        plugin = random # mandatory
30        pluginargs = -p plugin_specific_arg
31        priority = 6
32        timeout = 1
33        tos = 0xa0
34        waittime = 1
35
36        # [...]
37
38        *** Targets ***
39
40        probe = EchoPingPlugin # if this should be the default probe
41
42        # [...]
43
44        + mytarget
45        # probe = EchoPingPlugin # if the default probe is something else
46        host = my.host
47        /^influx_.+/ = influx_location = In the basement
48        extraopts = -some-letter-the-author-did-not-think-of
49        ipversion = 4
50        pings = 5
51        plugin = random # mandatory
52        pluginargs = -p plugin_specific_arg
53        priority = 6
54        timeout = 1
55        tos = 0xa0
56        waittime = 1
57

VARIABLES

59       Supported probe-specific variables:
60
61       binary
62           The location of your echoping binary.
63
64           Default value: /usr/bin/echoping
65
66       forks
67           Run this many concurrent processes at maximum
68
69           Example value: 5
70
71           Default value: 5
72
73       offset
74           If you run many probes concurrently you may want to prevent them
75           from hitting your network all at the same time. Using the probe-
76           specific offset parameter you can change the point in time when
77           each probe will be run. Offset is specified in % of total interval,
78           or alternatively as 'random', and the offset from the 'General'
79           section is used if nothing is specified here. Note that this does
80           NOT influence the rrds itself, it is just a matter of when data
81           acquisition is initiated.  (This variable is only applicable if the
82           variable 'concurrentprobes' is set in the 'General' section.)
83
84           Example value: 50%
85
86       step
87           Duration of the base interval that this probe should use, if
88           different from the one specified in the 'Database' section. Note
89           that the step in the RRD files is fixed when they are originally
90           generated, and if you change the step parameter afterwards, you'll
91           have to delete the old RRD files or somehow convert them. (This
92           variable is only applicable if the variable 'concurrentprobes' is
93           set in the 'General' section.)
94
95           Example value: 300
96
97       Supported target-specific variables:
98
99       /^influx_.+/
100           This is a tag that will be sent to influxdb and has no impact on
101           the probe measurement. The tag name will be sent without the
102           "influx_" prefix, which will be replaced with "tag_" instead. Tags
103           can be used for filtering.
104
105           Example value: influx_location = In the basement
106
107       extraopts
108           Any extra options specified here will be passed unmodified to
109           echoping(1).
110
111           Example value: -some-letter-the-author-did-not-think-of
112
113       ipversion
114           The IP protocol used. Possible values are "4" and "6".  Passed to
115           echoping(1) as the "-4" or "-6" options.
116
117           Example value: 4
118
119       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
126           Example value: 5
127
128       plugin
129           The echoping plugin that will be used. See echoping(1) for details.
130           This can either be the name of the plugin or a full path to the
131           plugin shared object.
132
133           Example value: random
134
135           This setting is mandatory.
136
137       pluginargs
138           Any extra arguments needed by the echoping plugin specified with
139           the pluginname variable. These are generally provided by the
140           subclass probe.
141
142           Example value: -p plugin_specific_arg
143
144       priority
145           The "-p" echoping(1) option.
146
147           Example value: 6
148
149       timeout
150           The "-t" echoping(1) option.
151
152           Example value: 1
153
154           Default value: 5
155
156       tos The "-P" echoping(1) option.
157
158           Example value: 0xa0
159
160       waittime
161           The "-w" echoping(1) option.
162
163           Example value: 1
164

AUTHORS

166       Niko Tyni <ntyni@iki.fi>
167

NOTES

169       The fill, size and udp EchoPing variables are not valid by default for
170       EchoPingPlugin -derived probes.
171
172       Plugins are available starting with echoping version 6.
173

NAME

OVERVIEW

SYNOPSIS

VARIABLES

AUTHORS

NOTES

SEE ALSO