~ubuntu-branches/debian/lenny/smokeping/lenny

« back to all changes in this revision

Viewing changes to doc/Smokeping/probes/EchoPingDiscard.html

  • Committer: Bazaar Package Importer
  • Author(s): Niko Tyni
  • Date: 2006-10-26 21:45:56 UTC
  • mfrom: (1.2.2 upstream) (2.1.5 edgy)
  • Revision ID: james.westby@ubuntu.com-20061026214556-5jnpiesx4vdijmu6
* debian/patches/15_clean_makefile.dpatch:
  + remove unneeded and potentially unsecure include paths.
* debian/patches: selected patches from the upstream SVN repository
  + 40_password.dpatch: skip reading the password file when running as a CGI.
  + 50_ldap.dpatch: Make the 'scope' option in the LDAP probe actually work.
  + 60_fping.dpatch:
    * Support the '-S' (set source address, see #198486) fping option.
    * Don't try to execute fping when running as a CGI.
  + 70_syslog.dpatch: Don't die silently if syslogd is unavailable.
    (Closes: #395056)
* Remove all the autogenerated documentation at clean time, to properly
  undo the effects of the 'build' target.
* Install example configuration files for documentation.

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
 
2
<html xmlns="http://www.w3.org/1999/xhtml">
 
3
<head>
 
4
<title>Smokeping/probes/EchoPingDiscard</title>
 
5
<link rev="made" href="mailto:dws@ee.ethz.ch" />
 
6
</head>
 
7
 
 
8
<body style="background-color: white">
 
9
 
 
10
<p><a name="__index__"></a></p>
 
11
<!-- INDEX BEGIN -->
 
12
<!--
 
13
 
 
14
<ul>
 
15
 
 
16
        <li><a href="#name">NAME</a></li>
 
17
        <li><a href="#overview">OVERVIEW</a></li>
 
18
        <li><a href="#synopsis">SYNOPSIS</a></li>
 
19
        <li><a href="#variables">VARIABLES</a></li>
 
20
        <li><a href="#authors">AUTHORS</a></li>
 
21
        <li><a href="#see_also">SEE ALSO</a></li>
 
22
</ul>
 
23
-->
 
24
<!-- INDEX END -->
 
25
 
 
26
<p>
 
27
</p>
 
28
<h1><a name="name">NAME</a></h1>
 
29
<p>Smokeping::probes::EchoPingDiscard - an <code>echoping(1)</code> probe for SmokePing</p>
 
30
<p>
 
31
</p>
 
32
<hr />
 
33
<h1><a name="overview">OVERVIEW</a></h1>
 
34
<p>Measures TCP or UDP discard (port 9) roundtrip times for SmokePing.</p>
 
35
<p>
 
36
</p>
 
37
<hr />
 
38
<h1><a name="synopsis">SYNOPSIS</a></h1>
 
39
<pre>
 
40
 *** Probes ***</pre>
 
41
<pre>
 
42
 +EchoPingDiscard</pre>
 
43
<pre>
 
44
 binary = /usr/bin/echoping
 
45
 forks = 5
 
46
 offset = 50%
 
47
 step = 300</pre>
 
48
<pre>
 
49
 # The following variables can be overridden in each target section
 
50
 extraopts = -some-letter-the-author-did-not-think-of
 
51
 fill = A
 
52
 ipversion = 4
 
53
 pings = 5
 
54
 priority = 6
 
55
 size = 510
 
56
 timeout = 1
 
57
 tos = 0xa0
 
58
 udp = no
 
59
 waittime = 1</pre>
 
60
<pre>
 
61
 # [...]</pre>
 
62
<pre>
 
63
 *** Targets ***</pre>
 
64
<pre>
 
65
 probe = EchoPingDiscard # if this should be the default probe</pre>
 
66
<pre>
 
67
 # [...]</pre>
 
68
<pre>
 
69
 + mytarget
 
70
 # probe = EchoPingDiscard # if the default probe is something else
 
71
 host = my.host
 
72
 extraopts = -some-letter-the-author-did-not-think-of
 
73
 fill = A
 
74
 ipversion = 4
 
75
 pings = 5
 
76
 priority = 6
 
77
 size = 510
 
78
 timeout = 1
 
79
 tos = 0xa0
 
80
 udp = no
 
81
 waittime = 1</pre>
 
82
<p>
 
83
</p>
 
84
<hr />
 
85
<h1><a name="variables">VARIABLES</a></h1>
 
86
<p>Supported probe-specific variables:</p>
 
87
<dl>
 
88
<dt><strong><a name="item_binary">binary</a></strong><br />
 
89
 
 
90
</dt><dd>
 
91
The location of your echoping binary.
 
92
 
 
93
</dd><dd>
 
94
<p>Default value: /usr/bin/echoping</p>
 
95
 
 
96
<p></p>
 
97
</dd><dt><strong><a name="item_forks">forks</a></strong><br />
 
98
 
 
99
</dt><dd>
 
100
Run this many concurrent processes at maximum
 
101
 
 
102
</dd><dd>
 
103
<p>Example value: 5</p>
 
104
 
 
105
</dd><dd>
 
106
<p>Default value: 5</p>
 
107
 
 
108
<p></p>
 
109
</dd><dt><strong><a name="item_offset">offset</a></strong><br />
 
110
 
 
111
</dt><dd>
 
112
If you run many probes concurrently you may want to prevent them from
 
113
hitting your network all at the same time. Using the probe-specific
 
114
offset parameter you can change the point in time when each probe will
 
115
be run. Offset is specified in % of total interval, or alternatively as
 
116
'random', and the offset from the 'General' section is used if nothing
 
117
is specified here. Note that this does NOT influence the rrds itself,
 
118
it is just a matter of when data acqusition is initiated.
 
119
(This variable is only applicable if the variable 'concurrentprobes' is set
 
120
in the 'General' section.)
 
121
 
 
122
</dd><dd>
 
123
<p>Example value: 50%</p>
 
124
 
 
125
<p></p>
 
126
</dd><dt><strong><a name="item_step">step</a></strong><br />
 
127
 
 
128
</dt><dd>
 
129
Duration of the base interval that this probe should use, if different
 
130
from the one specified in the 'Database' section. Note that the step in
 
131
the RRD files is fixed when they are originally generated, and if you
 
132
change the step parameter afterwards, you'll have to delete the old RRD
 
133
files or somehow convert them. (This variable is only applicable if
 
134
the variable 'concurrentprobes' is set in the 'General' section.)
 
135
 
 
136
</dd><dd>
 
137
<p>Example value: 300</p>
 
138
 
 
139
<p></p></dd></dl>
 
140
<p>Supported target-specific variables:</p>
 
141
<dl>
 
142
<dt><strong><a name="item_extraopts">extraopts</a></strong><br />
 
143
 
 
144
</dt><dd>
 
145
Any extra options specified here will be passed unmodified to echoping(1).
 
146
 
 
147
</dd><dd>
 
148
<p>Example value: -some-letter-the-author-did-not-think-of</p>
 
149
 
 
150
<p></p>
 
151
</dd><dt><strong><a name="item_fill">fill</a></strong><br />
 
152
 
 
153
</dt><dd>
 
154
The ``-f'' <code>echoping(1)</code> option.
 
155
 
 
156
</dd><dd>
 
157
<p>Example value: A</p>
 
158
 
 
159
<p></p>
 
160
</dd><dt><strong><a name="item_ipversion">ipversion</a></strong><br />
 
161
 
 
162
</dt><dd>
 
163
The IP protocol used. Possible values are ``4'' and ``6''. 
 
164
Passed to <code>echoping(1)</code> as the ``-4'' or ``-6'' options.
 
165
 
 
166
</dd><dd>
 
167
<p>Example value: 4</p>
 
168
 
 
169
<p></p>
 
170
</dd><dt><strong><a name="item_pings">pings</a></strong><br />
 
171
 
 
172
</dt><dd>
 
173
How many pings should be sent to each target, if different from the global
 
174
value specified in the Database section. Note that the number of pings in
 
175
the RRD files is fixed when they are originally generated, and if you
 
176
change this parameter afterwards, you'll have to delete the old RRD
 
177
files or somehow convert them.
 
178
 
 
179
</dd><dd>
 
180
<p>Example value: 5</p>
 
181
 
 
182
<p></p>
 
183
</dd><dt><strong><a name="item_priority">priority</a></strong><br />
 
184
 
 
185
</dt><dd>
 
186
The ``-p'' <code>echoping(1)</code> option.
 
187
 
 
188
</dd><dd>
 
189
<p>Example value: 6</p>
 
190
 
 
191
<p></p>
 
192
</dd><dt><strong><a name="item_size">size</a></strong><br />
 
193
 
 
194
</dt><dd>
 
195
The ``-s'' <code>echoping(1)</code> option.
 
196
 
 
197
</dd><dd>
 
198
<p>Example value: 510</p>
 
199
 
 
200
<p></p>
 
201
</dd><dt><strong><a name="item_timeout">timeout</a></strong><br />
 
202
 
 
203
</dt><dd>
 
204
The ``-t'' <code>echoping(1)</code> option.
 
205
 
 
206
</dd><dd>
 
207
<p>Example value: 1</p>
 
208
 
 
209
</dd><dd>
 
210
<p>Default value: 5</p>
 
211
 
 
212
<p></p>
 
213
</dd><dt><strong><a name="item_tos">tos</a></strong><br />
 
214
 
 
215
</dt><dd>
 
216
The ``-P'' <code>echoping(1)</code> option.
 
217
 
 
218
</dd><dd>
 
219
<p>Example value: 0xa0</p>
 
220
 
 
221
<p></p>
 
222
</dd><dt><strong><a name="item_udp">udp</a></strong><br />
 
223
 
 
224
</dt><dd>
 
225
The ``-u'' <code>echoping(1)</code> option. Values other than '0' and 'no' enable UDP.
 
226
 
 
227
</dd><dd>
 
228
<p>Example value: no</p>
 
229
 
 
230
<p></p>
 
231
</dd><dt><strong><a name="item_waittime">waittime</a></strong><br />
 
232
 
 
233
</dt><dd>
 
234
The ``-w'' <code>echoping(1)</code> option.
 
235
 
 
236
</dd><dd>
 
237
<p>Example value: 1</p>
 
238
 
 
239
<p></p></dd></dl>
 
240
<p>
 
241
</p>
 
242
<hr />
 
243
<h1><a name="authors">AUTHORS</a></h1>
 
244
<p>Niko Tyni &lt;<a href="mailto:ntyni@iki.fi">ntyni@iki.fi</a>&gt;</p>
 
245
<p>
 
246
</p>
 
247
<hr />
 
248
<h1><a name="see_also">SEE ALSO</a></h1>
 
249
<p><a href="./../../Smokeping/probes/EchoPing.html">the Smokeping::probes::EchoPing manpage</a></p>
 
250
 
 
251
</body>
 
252
 
 
253
</html>