~ubuntu-branches/debian/experimental/smokeping/experimental

« back to all changes in this revision

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

  • Committer: Bazaar Package Importer
  • Author(s): Niko Tyni
  • Date: 2008-08-29 18:29:34 UTC
  • mfrom: (2.1.14 intrepid)
  • Revision ID: james.westby@ubuntu.com-20080829182934-ad5b9csusoqn1155
Tags: 2.3.6-3
* Unset LC_ALL in the init script because the daemon needs to 
  reset LC_NUMERIC. (Closes: #489766)
* Fix a bashism in the postinst script. Thanks, lintian.

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
<?xml version="1.0" ?>
1
2
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
2
3
<html xmlns="http://www.w3.org/1999/xhtml">
3
4
<head>
4
5
<title>Smokeping/probes/EchoPingHttp</title>
5
 
<link rev="made" href="mailto:dws@ee.ethz.ch" />
 
6
<meta http-equiv="content-type" content="text/html; charset=utf-8" />
 
7
<link rev="made" href="mailto:root@localhost" />
6
8
</head>
7
9
 
8
10
<body style="background-color: white">
48
50
 step = 300</pre>
49
51
<pre>
50
52
 # The following variables can be overridden in each target section
 
53
 accept_redirects = yes
51
54
 extraopts = -some-letter-the-author-did-not-think-of
52
55
 ignore_cache = yes
53
56
 ipversion = 4
71
74
 + mytarget
72
75
 # probe = EchoPingHttp # if the default probe is something else
73
76
 host = my.host
 
77
 accept_redirects = yes
74
78
 extraopts = -some-letter-the-author-did-not-think-of
75
79
 ignore_cache = yes
76
80
 ipversion = 4
88
92
<h1><a name="variables">VARIABLES</a></h1>
89
93
<p>Supported probe-specific variables:</p>
90
94
<dl>
91
 
<dt><strong><a name="item_binary">binary</a></strong><br />
 
95
<dt><strong><a name="item_binary">binary</a></strong>
92
96
 
93
 
</dt><dd>
94
 
The location of your echoping binary.
 
97
<dd>
 
98
<p>The location of your echoping binary.</p>
95
99
 
96
100
</dd><dd>
97
101
<p>Default value: /usr/bin/echoping</p>
98
102
 
99
 
<p></p>
100
 
</dd><dt><strong><a name="item_forks">forks</a></strong><br />
 
103
</li>
 
104
</dd><dt><strong><a name="item_forks">forks</a></strong>
101
105
 
102
 
</dt><dd>
103
 
Run this many concurrent processes at maximum
 
106
<dd>
 
107
<p>Run this many concurrent processes at maximum</p>
104
108
 
105
109
</dd><dd>
106
110
<p>Example value: 5</p>
108
112
</dd><dd>
109
113
<p>Default value: 5</p>
110
114
 
111
 
<p></p>
112
 
</dd><dt><strong><a name="item_offset">offset</a></strong><br />
 
115
</li>
 
116
</dd><dt><strong><a name="item_offset">offset</a></strong>
113
117
 
114
 
</dt><dd>
115
 
If you run many probes concurrently you may want to prevent them from
 
118
<dd>
 
119
<p>If you run many probes concurrently you may want to prevent them from
116
120
hitting your network all at the same time. Using the probe-specific
117
121
offset parameter you can change the point in time when each probe will
118
122
be run. Offset is specified in % of total interval, or alternatively as
120
124
is specified here. Note that this does NOT influence the rrds itself,
121
125
it is just a matter of when data acqusition is initiated.
122
126
(This variable is only applicable if the variable 'concurrentprobes' is set
123
 
in the 'General' section.)
 
127
in the 'General' section.)</p>
124
128
 
125
129
</dd><dd>
126
130
<p>Example value: 50%</p>
127
131
 
128
 
<p></p>
129
 
</dd><dt><strong><a name="item_step">step</a></strong><br />
 
132
</li>
 
133
</dd><dt><strong><a name="item_step">step</a></strong>
130
134
 
131
 
</dt><dd>
132
 
Duration of the base interval that this probe should use, if different
 
135
<dd>
 
136
<p>Duration of the base interval that this probe should use, if different
133
137
from the one specified in the 'Database' section. Note that the step in
134
138
the RRD files is fixed when they are originally generated, and if you
135
139
change the step parameter afterwards, you'll have to delete the old RRD
136
140
files or somehow convert them. (This variable is only applicable if
137
 
the variable 'concurrentprobes' is set in the 'General' section.)
 
141
the variable 'concurrentprobes' is set in the 'General' section.)</p>
138
142
 
139
143
</dd><dd>
140
144
<p>Example value: 300</p>
141
145
 
142
 
<p></p></dd></dl>
 
146
</li>
 
147
</dd></dl>
143
148
<p>Supported target-specific variables:</p>
144
149
<dl>
145
 
<dt><strong><a name="item_extraopts">extraopts</a></strong><br />
146
 
 
147
 
</dt><dd>
148
 
Any extra options specified here will be passed unmodified to echoping(1).
 
150
<dt><strong><a name="item_accept_redirects">accept_redirects</a></strong>
 
151
 
 
152
<dd>
 
153
<p>The <code>echoping(1)</code> ``-R'' option: Accept  HTTP  status  codes  3xx (redirections) 
 
154
as normal responses instead of treating them as errors. Note that this option
 
155
is only available starting with Echoping 6.</p>
 
156
 
 
157
</dd><dd>
 
158
<p>Enabled if the value is anything other than 'no' or '0'.</p>
 
159
 
 
160
</dd><dd>
 
161
<p>Example value: yes</p>
 
162
 
 
163
</li>
 
164
</dd><dt><strong><a name="item_extraopts">extraopts</a></strong>
 
165
 
 
166
<dd>
 
167
<p>Any extra options specified here will be passed unmodified to echoping(1).</p>
149
168
 
150
169
</dd><dd>
151
170
<p>Example value: -some-letter-the-author-did-not-think-of</p>
152
171
 
153
 
<p></p>
154
 
</dd><dt><strong><a name="item_ignore_cache">ignore_cache</a></strong><br />
 
172
</li>
 
173
</dd><dt><strong><a name="item_ignore_cache">ignore_cache</a></strong>
155
174
 
156
 
</dt><dd>
157
 
The <code>echoping(1)</code> ``-A'' option: force the proxy to ignore the cache.
158
 
Enabled if the value is anything other than 'no' or '0'.
 
175
<dd>
 
176
<p>The <code>echoping(1)</code> ``-A'' option: force the proxy to ignore the cache.
 
177
Enabled if the value is anything other than 'no' or '0'.</p>
159
178
 
160
179
</dd><dd>
161
180
<p>Example value: yes</p>
162
181
 
163
 
<p></p>
164
 
</dd><dt><strong><a name="item_ipversion">ipversion</a></strong><br />
 
182
</li>
 
183
</dd><dt><strong><a name="item_ipversion">ipversion</a></strong>
165
184
 
166
 
</dt><dd>
167
 
The IP protocol used. Possible values are ``4'' and ``6''. 
168
 
Passed to <code>echoping(1)</code> as the ``-4'' or ``-6'' options.
 
185
<dd>
 
186
<p>The IP protocol used. Possible values are ``4'' and ``6''. 
 
187
Passed to <code>echoping(1)</code> as the ``-4'' or ``-6'' options.</p>
169
188
 
170
189
</dd><dd>
171
190
<p>Example value: 4</p>
172
191
 
173
 
<p></p>
174
 
</dd><dt><strong><a name="item_pings">pings</a></strong><br />
 
192
</li>
 
193
</dd><dt><strong><a name="item_pings">pings</a></strong>
175
194
 
176
 
</dt><dd>
177
 
How many pings should be sent to each target, if different from the global
 
195
<dd>
 
196
<p>How many pings should be sent to each target, if different from the global
178
197
value specified in the Database section. Note that the number of pings in
179
198
the RRD files is fixed when they are originally generated, and if you
180
199
change this parameter afterwards, you'll have to delete the old RRD
181
 
files or somehow convert them.
 
200
files or somehow convert them.</p>
182
201
 
183
202
</dd><dd>
184
203
<p>Example value: 5</p>
185
204
 
186
 
<p></p>
187
 
</dd><dt><strong><a name="item_port">port</a></strong><br />
 
205
</li>
 
206
</dd><dt><strong><a name="item_port">port</a></strong>
188
207
 
189
 
</dt><dd>
190
 
The TCP port to use.
 
208
<dd>
 
209
<p>The TCP port to use.</p>
191
210
 
192
211
</dd><dd>
193
212
<p>Example value: 80</p>
194
213
 
195
 
<p></p>
196
 
</dd><dt><strong><a name="item_priority">priority</a></strong><br />
 
214
</li>
 
215
</dd><dt><strong><a name="item_priority">priority</a></strong>
197
216
 
198
 
</dt><dd>
199
 
The ``-p'' <code>echoping(1)</code> option.
 
217
<dd>
 
218
<p>The ``-p'' <code>echoping(1)</code> option.</p>
200
219
 
201
220
</dd><dd>
202
221
<p>Example value: 6</p>
203
222
 
204
 
<p></p>
205
 
</dd><dt><strong><a name="item_revalidate_data">revalidate_data</a></strong><br />
 
223
</li>
 
224
</dd><dt><strong><a name="item_revalidate_data">revalidate_data</a></strong>
206
225
 
207
 
</dt><dd>
208
 
The <code>echoping(1)</code> ``-a'' option: force the proxy to revalidate data with original 
209
 
server. Enabled if the value is anything other than 'no' or '0'.
 
226
<dd>
 
227
<p>The <code>echoping(1)</code> ``-a'' option: force the proxy to revalidate data with original 
 
228
server. Enabled if the value is anything other than 'no' or '0'.</p>
210
229
 
211
230
</dd><dd>
212
231
<p>Example value: no</p>
213
232
 
214
 
<p></p>
215
 
</dd><dt><strong><a name="item_timeout">timeout</a></strong><br />
 
233
</li>
 
234
</dd><dt><strong><a name="item_timeout">timeout</a></strong>
216
235
 
217
 
</dt><dd>
218
 
The ``-t'' <code>echoping(1)</code> option.
 
236
<dd>
 
237
<p>The ``-t'' <code>echoping(1)</code> option.</p>
219
238
 
220
239
</dd><dd>
221
240
<p>Example value: 1</p>
223
242
</dd><dd>
224
243
<p>Default value: 5</p>
225
244
 
226
 
<p></p>
227
 
</dd><dt><strong><a name="item_tos">tos</a></strong><br />
 
245
</li>
 
246
</dd><dt><strong><a name="item_tos">tos</a></strong>
228
247
 
229
 
</dt><dd>
230
 
The ``-P'' <code>echoping(1)</code> option.
 
248
<dd>
 
249
<p>The ``-P'' <code>echoping(1)</code> option.</p>
231
250
 
232
251
</dd><dd>
233
252
<p>Example value: 0xa0</p>
234
253
 
235
 
<p></p>
236
 
</dd><dt><strong><a name="item_url">url</a></strong><br />
 
254
</li>
 
255
</dd><dt><strong><a name="item_url">url</a></strong>
237
256
 
238
 
</dt><dd>
239
 
The URL to be requested from the web server or cache. Can be either relative
240
 
(/...) for web servers or absolute (http://...) for caches.
 
257
<dd>
 
258
<p>The URL to be requested from the web server or cache. Can be either relative
 
259
(/...) for web servers or absolute (http://...) for caches.</p>
241
260
 
242
261
</dd><dd>
243
262
<p>Default value: /</p>
244
263
 
245
 
<p></p>
246
 
</dd><dt><strong><a name="item_waittime">waittime</a></strong><br />
 
264
</li>
 
265
</dd><dt><strong><a name="item_waittime">waittime</a></strong>
247
266
 
248
 
</dt><dd>
249
 
The ``-w'' <code>echoping(1)</code> option.
 
267
<dd>
 
268
<p>The ``-w'' <code>echoping(1)</code> option.</p>
250
269
 
251
270
</dd><dd>
252
271
<p>Example value: 1</p>
253
272
 
254
 
<p></p></dd></dl>
 
273
</li>
 
274
</dd></dl>
255
275
<p>
256
276
</p>
257
277
<hr />