Smokeping_probes_EchoPing(3)

1Smokeping_probes_EchoPing(3)       SmokePing      Smokeping_probes_EchoPing(3)
2
3
4

NAME

6       Smokeping::probes::EchoPing - an echoping(1) probe for SmokePing
7

OVERVIEW

9       Measures TCP or UDP echo (port 7) roundtrip times for SmokePing. Can
10       also be used as a base class for other echoping(1) probes.
11

SYNOPSIS

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

DESCRIPTION

57       See echoping(1) for details of the options below.
58

VARIABLES

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

AUTHORS

158       Niko Tyni <ntyni@iki.fi>
159

BUGS

161       Should we test the availability of the service at startup? After that
162       it's too late to complain.
163
164       The location of the echoping binary should probably be a global
165       variable instead of a probe-specific one. As things are, every EchoPing
166       -derived probe has to declare it if the default (/usr/bin/echoping)
167       isn't correct.
168