← Back to branch summary

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

« back to all changes in this revision

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

  • 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
http://bugs.debian.org/395056
* 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:
doc/Smokeping/probes/EchoPingHttp.pod
 
1
=head1 NAME
 
2
 
 
3
Smokeping::probes::EchoPingHttp - an echoping(1) probe for SmokePing
 
4
 
 
5
=head1 OVERVIEW
 
6
 
 
7
Measures HTTP roundtrip times (web servers and caches) for SmokePing.
 
8
 
 
9
=head1 SYNOPSIS
 
10
 
 
11
 *** Probes ***
 
12
 
 
13
 +EchoPingHttp
 
14
 
 
15
 binary = /usr/bin/echoping
 
16
 forks = 5
 
17
 offset = 50%
 
18
 step = 300
 
19
 
 
20
 # The following variables can be overridden in each target section
 
21
 extraopts = -some-letter-the-author-did-not-think-of
 
22
 ignore_cache = yes
 
23
 ipversion = 4
 
24
 pings = 5
 
25
 port = 80
 
26
 priority = 6
 
27
 revalidate_data = no
 
28
 timeout = 1
 
29
 tos = 0xa0
 
30
 url = /
 
31
 waittime = 1
 
32
 
 
33
 # [...]
 
34
 
 
35
 *** Targets ***
 
36
 
 
37
 probe = EchoPingHttp # if this should be the default probe
 
38
 
 
39
 # [...]
 
40
 
 
41
 + mytarget
 
42
 # probe = EchoPingHttp # if the default probe is something else
 
43
 host = my.host
 
44
 extraopts = -some-letter-the-author-did-not-think-of
 
45
 ignore_cache = yes
 
46
 ipversion = 4
 
47
 pings = 5
 
48
 port = 80
 
49
 priority = 6
 
50
 revalidate_data = no
 
51
 timeout = 1
 
52
 tos = 0xa0
 
53
 url = /
 
54
 waittime = 1
 
55
 
 
56
=head1 VARIABLES
 
57
 
 
58
Supported probe-specific variables:
 
59
 
 
60
=over
 
61
 
 
62
=item binary
 
63
 
 
64
The location of your echoping binary.
 
65
 
 
66
Default value: /usr/bin/echoping
 
67
 
 
68
=item forks
 
69
 
 
70
Run this many concurrent processes at maximum
 
71
 
 
72
Example value: 5
 
73
 
 
74
Default value: 5
 
75
 
 
76
=item offset
 
77
 
 
78
If you run many probes concurrently you may want to prevent them from
 
79
hitting your network all at the same time. Using the probe-specific
 
80
offset parameter you can change the point in time when each probe will
 
81
be run. Offset is specified in % of total interval, or alternatively as
 
82
'random', and the offset from the 'General' section is used if nothing
 
83
is specified here. Note that this does NOT influence the rrds itself,
 
84
it is just a matter of when data acqusition is initiated.
 
85
(This variable is only applicable if the variable 'concurrentprobes' is set
 
86
in the 'General' section.)
 
87
 
 
88
Example value: 50%
 
89
 
 
90
=item step
 
91
 
 
92
Duration of the base interval that this probe should use, if different
 
93
from the one specified in the 'Database' section. Note that the step in
 
94
the RRD files is fixed when they are originally generated, and if you
 
95
change the step parameter afterwards, you'll have to delete the old RRD
 
96
files or somehow convert them. (This variable is only applicable if
 
97
the variable 'concurrentprobes' is set in the 'General' section.)
 
98
 
 
99
Example value: 300
 
100
 
 
101
=back
 
102
 
 
103
Supported target-specific variables:
 
104
 
 
105
=over
 
106
 
 
107
=item extraopts
 
108
 
 
109
Any extra options specified here will be passed unmodified to echoping(1).
 
110
 
 
111
Example value: -some-letter-the-author-did-not-think-of
 
112
 
 
113
=item ignore_cache
 
114
 
 
115
The echoping(1) "-A" option: force the proxy to ignore the cache.
 
116
Enabled if the value is anything other than 'no' or '0'.
 
117
 
 
118
Example value: yes
 
119
 
 
120
=item ipversion
 
121
 
 
122
The IP protocol used. Possible values are "4" and "6". 
 
123
Passed to echoping(1) as the "-4" or "-6" options.
 
124
 
 
125
Example value: 4
 
126
 
 
127
=item pings
 
128
 
 
129
How many pings should be sent to each target, if different from the global
 
130
value specified in the Database section. Note that the number of pings in
 
131
the RRD files is fixed when they are originally generated, and if you
 
132
change this parameter afterwards, you'll have to delete the old RRD
 
133
files or somehow convert them.
 
134
 
 
135
Example value: 5
 
136
 
 
137
=item port
 
138
 
 
139
The TCP port to use.
 
140
 
 
141
Example value: 80
 
142
 
 
143
=item priority
 
144
 
 
145
The "-p" echoping(1) option.
 
146
 
 
147
Example value: 6
 
148
 
 
149
=item revalidate_data
 
150
 
 
151
The echoping(1) "-a" option: force the proxy to revalidate data with original 
 
152
server. Enabled if the value is anything other than 'no' or '0'.
 
153
 
 
154
Example value: no
 
155
 
 
156
=item timeout
 
157
 
 
158
The "-t" echoping(1) option.
 
159
 
 
160
Example value: 1
 
161
 
 
162
Default value: 5
 
163
 
 
164
=item tos
 
165
 
 
166
The "-P" echoping(1) option.
 
167
 
 
168
Example value: 0xa0
 
169
 
 
170
=item url
 
171
 
 
172
The URL to be requested from the web server or cache. Can be either relative
 
173
(/...) for web servers or absolute (http://...) for caches.
 
174
 
 
175
Default value: /
 
176
 
 
177
=item waittime
 
178
 
 
179
The "-w" echoping(1) option.
 
180
 
 
181
Example value: 1
 
182
 
 
183
=back
 
184
 
 
185
 
 
186
=head1 AUTHORS
 
187
 
 
188
Niko Tyni <ntyni@iki.fi>
 
189
 
 
190
=head1 NOTES
 
191
 
 
192
You should consider setting a lower value for the C<pings> variable than the
 
193
default 20, as repetitive URL fetching may be quite heavy on the server.
 
194
 
 
195
The I<fill>, I<size> and I<udp> EchoPing variables are not valid for EchoPingHttp.
 
196
 
 
197
=head1 SEE ALSO
 
198
 
 
199
L<Smokeping::probes::EchoPing>, L<Smokeping::probes::EchoPingHttps>
 
200
 
 
201
=cut
 
 
b'\\ No newline at end of file'