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        extraopts = -some-letter-the-author-did-not-think-of
26        ipversion = 4
27        pings = 5
28        plugin = random # mandatory
29        pluginargs = -p plugin_specific_arg
30        priority = 6
31        timeout = 1
32        tos = 0xa0
33        waittime = 1
34
35        # [...]
36
37        *** Targets ***
38
39        probe = EchoPingPlugin # if this should be the default probe
40
41        # [...]
42
43        + mytarget
44        # probe = EchoPingPlugin # if the default probe is something else
45        host = my.host
46        extraopts = -some-letter-the-author-did-not-think-of
47        ipversion = 4
48        pings = 5
49        plugin = random # mandatory
50        pluginargs = -p plugin_specific_arg
51        priority = 6
52        timeout = 1
53        tos = 0xa0
54        waittime = 1
55

VARIABLES

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

AUTHORS

156       Niko Tyni <ntyni@iki.fi>
157

NOTES

159       The fill, size and udp EchoPing variables are not valid by default for
160       EchoPingPlugin -derived probes.
161
162       Plugins are available starting with echoping version 6.
163

NAME

OVERVIEW

SYNOPSIS

VARIABLES

AUTHORS

NOTES

SEE ALSO