Smokeping_probes_EchoPingHttps(3)

1Smokeping_probes_EchoPingHttps(3)  SmokePing Smokeping_probes_EchoPingHttps(3)
2
3
4

NAME

6       Smokeping::probes::EchoPingHttps - an echoping(1) probe for SmokePing
7

OVERVIEW

9       Measures HTTPS (HTTP over SSL) roundtrip times (web servers and caches)
10       for SmokePing.
11

SYNOPSIS

13        *** Probes ***
14
15        +EchoPingHttps
16
17        binary = /usr/bin/echoping
18        forks = 5
19        offset = 50%
20        step = 300
21
22        # The following variables can be overridden in each target section
23        accept_redirects = yes
24        extraopts = -some-letter-the-author-did-not-think-of
25        ignore_cache = yes
26        ipversion = 4
27        pings = 5
28        port = 80
29        priority = 6
30        prot = 3443
31        revalidate_data = no
32        timeout = 20
33        tos = 0xa0
34        url = /
35        waittime = 1
36
37        # [...]
38
39        *** Targets ***
40
41        probe = EchoPingHttps # if this should be the default probe
42
43        # [...]
44
45        + mytarget
46        # probe = EchoPingHttps # if the default probe is something else
47        host = my.host
48        accept_redirects = yes
49        extraopts = -some-letter-the-author-did-not-think-of
50        ignore_cache = yes
51        ipversion = 4
52        pings = 5
53        port = 80
54        priority = 6
55        prot = 3443
56        revalidate_data = no
57        timeout = 20
58        tos = 0xa0
59        url = /
60        waittime = 1
61

DESCRIPTION

63       As EchoPingHttp(3pm), but SSL-enabled.
64

VARIABLES

66       Supported probe-specific variables:
67
68       binary
69           The location of your echoping binary.
70
71           Default value: /usr/bin/echoping
72
73       forks
74           Run this many concurrent processes at maximum
75
76           Example value: 5
77
78           Default value: 5
79
80       offset
81           If you run many probes concurrently you may want to prevent them
82           from hitting your network all at the same time. Using the probe-
83           specific offset parameter you can change the point in time when
84           each probe will be run. Offset is specified in % of total interval,
85           or alternatively as 'random', and the offset from the 'General'
86           section is used if nothing is specified here. Note that this does
87           NOT influence the rrds itself, it is just a matter of when data
88           acqusition is initiated.  (This variable is only applicable if the
89           variable 'concurrentprobes' is set in the 'General' section.)
90
91           Example value: 50%
92
93       step
94           Duration of the base interval that this probe should use, if
95           different from the one specified in the 'Database' section. Note
96           that the step in the RRD files is fixed when they are originally
97           generated, and if you change the step parameter afterwards, you'll
98           have to delete the old RRD files or somehow convert them. (This
99           variable is only applicable if the variable 'concurrentprobes' is
100           set in the 'General' section.)
101
102           Example value: 300
103
104       Supported target-specific variables:
105
106       accept_redirects
107           The echoping(1) "-R" option: Accept  HTTP  status  codes  3xx
108           (redirections) as normal responses instead of treating them as
109           errors. Note that this option is only available starting with
110           Echoping 6.
111
112           Enabled if the value is anything other than 'no' or '0'.
113
114           Example value: yes
115
116       extraopts
117           Any extra options specified here will be passed unmodified to
118           echoping(1).
119
120           Example value: -some-letter-the-author-did-not-think-of
121
122       ignore_cache
123           The echoping(1) "-A" option: force the proxy to ignore the cache.
124           Enabled if the value is anything other than 'no' or '0'.
125
126           Example value: yes
127
128       ipversion
129           The IP protocol used. Possible values are "4" and "6".  Passed to
130           echoping(1) as the "-4" or "-6" options.
131
132           Example value: 4
133
134       pings
135           How many pings should be sent to each target, if different from the
136           global value specified in the Database section. Note that the
137           number of pings in the RRD files is fixed when they are originally
138           generated, and if you change this parameter afterwards, you'll have
139           to delete the old RRD files or somehow convert them.
140
141           Example value: 5
142
143       port
144           The TCP port to use.
145
146           Example value: 80
147
148       priority
149           The "-p" echoping(1) option.
150
151           Example value: 6
152
153       prot
154           Example value: 3443
155
156           Default value: 443
157
158       revalidate_data
159           The echoping(1) "-a" option: force the proxy to revalidate data
160           with original server. Enabled if the value is anything other than
161           'no' or '0'.
162
163           Example value: no
164
165       timeout
166           The "-t" echoping(1) option.
167
168           Example value: 20
169
170           Default value: 10
171
172       tos The "-P" echoping(1) option.
173
174           Example value: 0xa0
175
176       url The URL to be requested from the web server or cache. Can be either
177           relative (/...) for web servers or absolute (http://...) for
178           caches.
179
180           Default value: /
181
182       waittime
183           The "-w" echoping(1) option.
184
185           Example value: 1
186

AUTHORS

188       Niko Tyni <ntyni@iki.fi>
189

NOTES

191       You should consider setting a lower value for the "pings" variable than
192       the default 20, as repetitive URL fetching may be quite heavy on the
193       server.
194