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

« back to all changes in this revision

Viewing changes to doc/Smokeping/probes/EchoPingHttps.txt

  • 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
 
doc::Smokeping::probes::EcdhoocPS:im:noSgkmHeotPktiepnpsgi(n3g)::probes::EchoPingHttps(3)
 
1
doc::Smokeping::probes::EchoPingHttpSsm(o3kd)eoPci:n:gSmokeping::probes::EchoPingHttps(3)
2
2
 
3
3
 
4
4
 
5
5
NNAAMMEE
6
 
       Smokeping::probes::EchoPingHttps - an echoping(1) probe
7
 
       for SmokePing
 
6
       Smokeping::probes::EchoPingHttps - an echoping(1) probe for SmokePing
8
7
 
9
8
OOVVEERRVVIIEEWW
10
 
       Measures HTTPS (HTTP over SSL) roundtrip times (web
11
 
       servers and caches) for SmokePing.
 
9
       Measures HTTPS (HTTP over SSL) roundtrip times (web servers and caches)
 
10
       for SmokePing.
12
11
 
13
12
SSYYNNOOPPSSIISS
14
13
        *** Probes ***
21
20
        step = 300
22
21
 
23
22
        # The following variables can be overridden in each target section
 
23
        accept_redirects = yes
24
24
        extraopts = -some-letter-the-author-did-not-think-of
25
25
        ignore_cache = yes
26
26
        ipversion = 4
44
44
        + mytarget
45
45
        # probe = EchoPingHttps # if the default probe is something else
46
46
        host = my.host
 
47
        accept_redirects = yes
47
48
        extraopts = -some-letter-the-author-did-not-think-of
48
49
        ignore_cache = yes
49
50
        ipversion = 4
75
76
           Default value: 5
76
77
 
77
78
       offset
78
 
           If you run many probes concurrently you may want to
79
 
           prevent them from hitting your network all at the same
80
 
           time. Using the probe-specific offset parameter you
81
 
           can change the point in time when each probe will be
82
 
           run. Offset is specified in % of total interval, or
83
 
           alternatively as 'random', and the offset from the
84
 
           'General' section is used if nothing is specified
85
 
           here. Note that this does NOT influence the rrds
86
 
           itself, it is just a matter of when data acqusition is
87
 
           initiated.  (This variable is only applicable if the
88
 
           variable 'concurrentprobes' is set in the 'General'
89
 
           section.)
 
79
           If you run many probes concurrently you may want to prevent them
 
80
           from hitting your network all at the same time. Using the probe-
 
81
           specific offset parameter you can change the point in time when
 
82
           each probe will be run. Offset is specified in % of total interval,
 
83
           or alternatively as 'random', and the offset from the 'General'
 
84
           section is used if nothing is specified here. Note that this does
 
85
           NOT influence the rrds itself, it is just a matter of when data
 
86
           acqusition is initiated.  (This variable is only applicable if the
 
87
           variable 'concurrentprobes' is set in the 'General' section.)
90
88
 
91
89
           Example value: 50%
92
90
 
93
91
       step
94
 
           Duration of the base interval that this probe should
95
 
           use, if different from the one specified in the
96
 
           'Database' section. Note that the step in the RRD
97
 
           files is fixed when they are originally generated, and
98
 
           if you change the step parameter afterwards, you'll
99
 
           have to delete the old RRD files or somehow convert
100
 
           them. (This variable is only applicable if the vari-
101
 
           able 'concurrentprobes' is set in the 'General' sec-
102
 
           tion.)
 
92
           Duration of the base interval that this probe should use, if dif-
 
93
           ferent from the one specified in the 'Database' section. Note that
 
94
           the step in the RRD files is fixed when they are originally gener-
 
95
           ated, and if you change the step parameter afterwards, you'll have
 
96
           to delete the old RRD files or somehow convert them. (This variable
 
97
           is only applicable if the variable 'concurrentprobes' is set in the
 
98
           'General' section.)
103
99
 
104
100
           Example value: 300
105
101
 
106
102
       Supported target-specific variables:
107
103
 
 
104
       accept_redirects
 
105
           The _e_c_h_o_p_i_n_g(1) "-R" option: Accept  HTTP  status  codes  3xx
 
106
           (redirections) as normal responses instead of treating them as
 
107
           errors. Note that this option is only available starting with
 
108
           Echoping 6.
 
109
 
 
110
           Enabled if the value is anything other than 'no' or '0'.
 
111
 
 
112
           Example value: yes
 
113
 
108
114
       extraopts
109
 
           Any extra options specified here will be passed unmod-
110
 
           ified to _e_c_h_o_p_i_n_g(1).
 
115
           Any extra options specified here will be passed unmodified to
 
116
           _e_c_h_o_p_i_n_g(1).
111
117
 
112
 
           Example value: -some-let-
113
 
           ter-the-author-did-not-think-of
 
118
           Example value: -some-letter-the-author-did-not-think-of
114
119
 
115
120
       ignore_cache
116
 
           The _e_c_h_o_p_i_n_g(1) "-A" option: force the proxy to ignore
117
 
           the cache.  Enabled if the value is anything other
118
 
           than 'no' or '0'.
 
121
           The _e_c_h_o_p_i_n_g(1) "-A" option: force the proxy to ignore the cache.
 
122
           Enabled if the value is anything other than 'no' or '0'.
119
123
 
120
124
           Example value: yes
121
125
 
122
126
       ipversion
123
 
           The IP protocol used. Possible values are "4" and "6".
124
 
           Passed to _e_c_h_o_p_i_n_g(1) as the "-4" or "-6" options.
 
127
           The IP protocol used. Possible values are "4" and "6".  Passed to
 
128
           _e_c_h_o_p_i_n_g(1) as the "-4" or "-6" options.
125
129
 
126
130
           Example value: 4
127
131
 
128
132
       pings
129
 
           How many pings should be sent to each target, if dif-
130
 
           ferent from the global value specified in the Database
131
 
           section. Note that the number of pings in the RRD
132
 
           files is fixed when they are originally generated, and
133
 
           if you change this parameter afterwards, you'll have
 
133
           How many pings should be sent to each target, if different from the
 
134
           global value specified in the Database section. Note that the num-
 
135
           ber of pings in the RRD files is fixed when they are originally
 
136
           generated, and if you change this parameter afterwards, you'll have
134
137
           to delete the old RRD files or somehow convert them.
135
138
 
136
139
           Example value: 5
146
149
           Example value: 6
147
150
 
148
151
       revalidate_data
149
 
           The _e_c_h_o_p_i_n_g(1) "-a" option: force the proxy to reval-
150
 
           idate data with original server. Enabled if the value
151
 
           is anything other than 'no' or '0'.
 
152
           The _e_c_h_o_p_i_n_g(1) "-a" option: force the proxy to revalidate data
 
153
           with original server. Enabled if the value is anything other than
 
154
           'no' or '0'.
152
155
 
153
156
           Example value: no
154
157
 
163
166
 
164
167
           Example value: 0xa0
165
168
 
166
 
       url The URL to be requested from the web server or cache.
167
 
           Can be either relative (/...) for web servers or abso-
168
 
           lute (http://...) for caches.
 
169
       url The URL to be requested from the web server or cache. Can be either
 
170
           relative (/...) for web servers or absolute (http://...) for
 
171
           caches.
169
172
 
170
173
           Default value: /
171
174
 
178
181
       Niko Tyni <ntyni@iki.fi>
179
182
 
180
183
NNOOTTEESS
181
 
       You should consider setting a lower value for the "pings"
182
 
       variable than the default 20, as repetitive URL fetching
183
 
       may be quite heavy on the server.
 
184
       You should consider setting a lower value for the "pings" variable than
 
185
       the default 20, as repetitive URL fetching may be quite heavy on the
 
186
       server.
184
187
 
185
188
SSEEEE AALLSSOO
186
189
       Smokeping::probes::EchoPingHttp
187
190
 
188
191
 
189
192
 
190
 
2.0.9                    doc2:0:0S6m-o0k7e-p1i4ng::probes::EchoPingHttps(3)
 
193
2.3.6                             2008-d0o4c-:2:6Smokeping::probes::EchoPingHttps(3)