1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
|
<?xml version="1.0" ?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<title>Smokeping/probes/EchoPingHttps</title>
<meta http-equiv="content-type" content="text/html; charset=utf-8" />
<link rev="made" href="mailto:root@localhost" />
</head>
<body style="background-color: white">
<p><a name="__index__"></a></p>
<!-- INDEX BEGIN -->
<!--
<ul>
<li><a href="#name">NAME</a></li>
<li><a href="#overview">OVERVIEW</a></li>
<li><a href="#synopsis">SYNOPSIS</a></li>
<li><a href="#description">DESCRIPTION</a></li>
<li><a href="#variables">VARIABLES</a></li>
<li><a href="#authors">AUTHORS</a></li>
<li><a href="#notes">NOTES</a></li>
<li><a href="#see_also">SEE ALSO</a></li>
</ul>
-->
<!-- INDEX END -->
<p>
</p>
<h1><a name="name">NAME</a></h1>
<p>Smokeping::probes::EchoPingHttps - an <code>echoping(1)</code> probe for SmokePing</p>
<p>
</p>
<hr />
<h1><a name="overview">OVERVIEW</a></h1>
<p>Measures HTTPS (HTTP over SSL) roundtrip times (web servers and caches) for
SmokePing.</p>
<p>
</p>
<hr />
<h1><a name="synopsis">SYNOPSIS</a></h1>
<pre>
*** Probes ***</pre>
<pre>
+EchoPingHttps</pre>
<pre>
binary = /usr/bin/echoping
forks = 5
offset = 50%
step = 300</pre>
<pre>
# The following variables can be overridden in each target section
accept_redirects = yes
extraopts = -some-letter-the-author-did-not-think-of
ignore_cache = yes
ipversion = 4
pings = 5
port = 80
priority = 6
revalidate_data = no
timeout = 1
tos = 0xa0
url = /
waittime = 1</pre>
<pre>
# [...]</pre>
<pre>
*** Targets ***</pre>
<pre>
probe = EchoPingHttps # if this should be the default probe</pre>
<pre>
# [...]</pre>
<pre>
+ mytarget
# probe = EchoPingHttps # if the default probe is something else
host = my.host
accept_redirects = yes
extraopts = -some-letter-the-author-did-not-think-of
ignore_cache = yes
ipversion = 4
pings = 5
port = 80
priority = 6
revalidate_data = no
timeout = 1
tos = 0xa0
url = /
waittime = 1</pre>
<p>
</p>
<hr />
<h1><a name="description">DESCRIPTION</a></h1>
<p>As EchoPingHttp(3pm), but SSL-enabled.</p>
<p>
</p>
<hr />
<h1><a name="variables">VARIABLES</a></h1>
<p>Supported probe-specific variables:</p>
<dl>
<dt><strong><a name="item_binary">binary</a></strong>
<dd>
<p>The location of your echoping binary.</p>
</dd><dd>
<p>Default value: /usr/bin/echoping</p>
</li>
</dd><dt><strong><a name="item_forks">forks</a></strong>
<dd>
<p>Run this many concurrent processes at maximum</p>
</dd><dd>
<p>Example value: 5</p>
</dd><dd>
<p>Default value: 5</p>
</li>
</dd><dt><strong><a name="item_offset">offset</a></strong>
<dd>
<p>If you run many probes concurrently you may want to prevent them from
hitting your network all at the same time. Using the probe-specific
offset parameter you can change the point in time when each probe will
be run. Offset is specified in % of total interval, or alternatively as
'random', and the offset from the 'General' section is used if nothing
is specified here. Note that this does NOT influence the rrds itself,
it is just a matter of when data acqusition is initiated.
(This variable is only applicable if the variable 'concurrentprobes' is set
in the 'General' section.)</p>
</dd><dd>
<p>Example value: 50%</p>
</li>
</dd><dt><strong><a name="item_step">step</a></strong>
<dd>
<p>Duration of the base interval that this probe should use, if different
from the one specified in the 'Database' section. Note that the step in
the RRD files is fixed when they are originally generated, and if you
change the step parameter afterwards, you'll have to delete the old RRD
files or somehow convert them. (This variable is only applicable if
the variable 'concurrentprobes' is set in the 'General' section.)</p>
</dd><dd>
<p>Example value: 300</p>
</li>
</dd></dl>
<p>Supported target-specific variables:</p>
<dl>
<dt><strong><a name="item_accept_redirects">accept_redirects</a></strong>
<dd>
<p>The <code>echoping(1)</code> ``-R'' option: Accept HTTP status codes 3xx (redirections)
as normal responses instead of treating them as errors. Note that this option
is only available starting with Echoping 6.</p>
</dd><dd>
<p>Enabled if the value is anything other than 'no' or '0'.</p>
</dd><dd>
<p>Example value: yes</p>
</li>
</dd><dt><strong><a name="item_extraopts">extraopts</a></strong>
<dd>
<p>Any extra options specified here will be passed unmodified to echoping(1).</p>
</dd><dd>
<p>Example value: -some-letter-the-author-did-not-think-of</p>
</li>
</dd><dt><strong><a name="item_ignore_cache">ignore_cache</a></strong>
<dd>
<p>The <code>echoping(1)</code> ``-A'' option: force the proxy to ignore the cache.
Enabled if the value is anything other than 'no' or '0'.</p>
</dd><dd>
<p>Example value: yes</p>
</li>
</dd><dt><strong><a name="item_ipversion">ipversion</a></strong>
<dd>
<p>The IP protocol used. Possible values are ``4'' and ``6''.
Passed to <code>echoping(1)</code> as the ``-4'' or ``-6'' options.</p>
</dd><dd>
<p>Example value: 4</p>
</li>
</dd><dt><strong><a name="item_pings">pings</a></strong>
<dd>
<p>How many pings should be sent to each target, if different from the global
value specified in the Database section. Note that the number of pings in
the RRD files is fixed when they are originally generated, and if you
change this parameter afterwards, you'll have to delete the old RRD
files or somehow convert them.</p>
</dd><dd>
<p>Example value: 5</p>
</li>
</dd><dt><strong><a name="item_port">port</a></strong>
<dd>
<p>The TCP port to use.</p>
</dd><dd>
<p>Example value: 80</p>
</li>
</dd><dt><strong><a name="item_priority">priority</a></strong>
<dd>
<p>The ``-p'' <code>echoping(1)</code> option.</p>
</dd><dd>
<p>Example value: 6</p>
</li>
</dd><dt><strong><a name="item_revalidate_data">revalidate_data</a></strong>
<dd>
<p>The <code>echoping(1)</code> ``-a'' option: force the proxy to revalidate data with original
server. Enabled if the value is anything other than 'no' or '0'.</p>
</dd><dd>
<p>Example value: no</p>
</li>
</dd><dt><strong><a name="item_timeout">timeout</a></strong>
<dd>
<p>The ``-t'' <code>echoping(1)</code> option.</p>
</dd><dd>
<p>Example value: 1</p>
</dd><dd>
<p>Default value: 5</p>
</li>
</dd><dt><strong><a name="item_tos">tos</a></strong>
<dd>
<p>The ``-P'' <code>echoping(1)</code> option.</p>
</dd><dd>
<p>Example value: 0xa0</p>
</li>
</dd><dt><strong><a name="item_url">url</a></strong>
<dd>
<p>The URL to be requested from the web server or cache. Can be either relative
(/...) for web servers or absolute (http://...) for caches.</p>
</dd><dd>
<p>Default value: /</p>
</li>
</dd><dt><strong><a name="item_waittime">waittime</a></strong>
<dd>
<p>The ``-w'' <code>echoping(1)</code> option.</p>
</dd><dd>
<p>Example value: 1</p>
</li>
</dd></dl>
<p>
</p>
<hr />
<h1><a name="authors">AUTHORS</a></h1>
<p>Niko Tyni <<a href="mailto:ntyni@iki.fi">ntyni@iki.fi</a>></p>
<p>
</p>
<hr />
<h1><a name="notes">NOTES</a></h1>
<p>You should consider setting a lower value for the <a href="#item_pings"><code>pings</code></a> variable than the
default 20, as repetitive URL fetching may be quite heavy on the server.</p>
<p>
</p>
<hr />
<h1><a name="see_also">SEE ALSO</a></h1>
<p><a href="./../../Smokeping/probes/EchoPingHttp.html">the Smokeping::probes::EchoPingHttp manpage</a></p>
</body>
</html>
|