~ubuntu-branches/debian/squeeze/smokeping/squeeze

« back to all changes in this revision

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