1
.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.14
4
.\" ========================================================================
5
.de Sh \" Subsection heading
13
.de Sp \" Vertical space (when we can't use .PP)
17
.de Vb \" Begin verbatim text
22
.de Ve \" End verbatim text
26
.\" Set up some character translations and predefined strings. \*(-- will
27
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
28
.\" double quote, and \*(R" will give a right double quote. | will give a
29
.\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to
30
.\" do unbreakable dashes and therefore won't be available. \*(C` and \*(C'
31
.\" expand to `' in nroff, nothing in troff, for use with C<>.
33
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
37
. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
38
. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
51
.\" If the F register is turned on, we'll generate index entries on stderr for
52
.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
53
.\" entries marked with X<> in POD. Of course, you'll have to process the
54
.\" output yourself in some meaningful fashion.
57
. tm Index:\\$1\t\\n%\t"\\$2"
63
.\" For nroff, turn off justification. Always turn off hyphenation; it makes
64
.\" way too many mistakes in technical documents.
68
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
69
.\" Fear. Run. Save yourself. No user-serviceable parts.
70
. \" fudge factors for nroff and troff
79
. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
85
. \" simple accents for nroff and troff
95
. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
96
. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
97
. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
98
. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
99
. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
100
. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
102
. \" troff and (daisy-wheel) nroff accents
103
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
104
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
105
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
106
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
107
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
108
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
109
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
110
.ds ae a\h'-(\w'a'u*4/10)'e
111
.ds Ae A\h'-(\w'A'u*4/10)'E
112
. \" corrections for vroff
113
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
114
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
115
. \" for low resolution devices (crt and lpr)
116
.if \n(.H>23 .if \n(.V>19 \
129
.\" ========================================================================
131
.IX Title "doc::Smokeping::probes::EchoPing 3"
132
.TH doc::Smokeping::probes::EchoPing 3 "2006-07-14" "2.0.9" "SmokePing"
134
Smokeping::probes::EchoPing \- an echoping(1) probe for SmokePing
136
.IX Header "OVERVIEW"
137
Measures \s-1TCP\s0 or \s-1UDP\s0 echo (port 7) roundtrip times for SmokePing. Can also be
138
used as a base class for other \fIechoping\fR\|(1) probes.
140
.IX Header "SYNOPSIS"
150
\& binary = /usr/bin/echoping
157
\& # The following variables can be overridden in each target section
158
\& extraopts = -some-letter-the-author-did-not-think-of
179
\& probe = EchoPing # if this should be the default probe
188
\& # probe = EchoPing # if the default probe is something else
190
\& extraopts = -some-letter-the-author-did-not-think-of
202
.IX Header "DESCRIPTION"
203
See \fIechoping\fR\|(1) for details of the options below.
205
.IX Header "VARIABLES"
206
Supported probe-specific variables:
209
The location of your echoping binary.
211
Default value: /usr/bin/echoping
214
Run this many concurrent processes at maximum
221
If you run many probes concurrently you may want to prevent them from
222
hitting your network all at the same time. Using the probe-specific
223
offset parameter you can change the point in time when each probe will
224
be run. Offset is specified in % of total interval, or alternatively as
225
\&'random', and the offset from the 'General' section is used if nothing
226
is specified here. Note that this does \s-1NOT\s0 influence the rrds itself,
227
it is just a matter of when data acqusition is initiated.
228
(This variable is only applicable if the variable 'concurrentprobes' is set
229
in the 'General' section.)
234
Duration of the base interval that this probe should use, if different
235
from the one specified in the 'Database' section. Note that the step in
236
the \s-1RRD\s0 files is fixed when they are originally generated, and if you
237
change the step parameter afterwards, you'll have to delete the old \s-1RRD\s0
238
files or somehow convert them. (This variable is only applicable if
239
the variable 'concurrentprobes' is set in the 'General' section.)
243
Supported target-specific variables:
246
Any extra options specified here will be passed unmodified to \fIechoping\fR\|(1).
248
Example value: \-some\-letter\-the\-author\-did\-not\-think\-of
251
The \*(L"\-f\*(R" \fIechoping\fR\|(1) option.
256
The \s-1IP\s0 protocol used. Possible values are \*(L"4\*(R" and \*(L"6\*(R".
257
Passed to \fIechoping\fR\|(1) as the \*(L"\-4\*(R" or \*(L"\-6\*(R" options.
262
How many pings should be sent to each target, if different from the global
263
value specified in the Database section. Note that the number of pings in
264
the \s-1RRD\s0 files is fixed when they are originally generated, and if you
265
change this parameter afterwards, you'll have to delete the old \s-1RRD\s0
266
files or somehow convert them.
271
The \*(L"\-p\*(R" \fIechoping\fR\|(1) option.
276
The \*(L"\-s\*(R" \fIechoping\fR\|(1) option.
281
The \*(L"\-t\*(R" \fIechoping\fR\|(1) option.
288
The \*(L"\-P\*(R" \fIechoping\fR\|(1) option.
293
The \*(L"\-u\*(R" \fIechoping\fR\|(1) option. Values other than '0' and 'no' enable \s-1UDP\s0.
298
The \*(L"\-w\*(R" \fIechoping\fR\|(1) option.
303
Niko Tyni <ntyni@iki.fi>
306
Should we test the availability of the service at startup? After that it's
307
too late to complain.
309
The location of the echoping binary should probably be a global variable
310
instead of a probe-specific one. As things are, every EchoPing \-derived probe
311
has to declare it if the default (/usr/bin/echoping) isn't correct.
313
.IX Header "SEE ALSO"
314
\&\fIechoping\fR\|(1), Smokeping::probes::EchoPingHttp etc., <http://echoping.sourceforge.net/>
added
removed
doc/Smokeping/probes/Smokeping::probes::EchoPing.3
