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        /^influx_.+/ = influx_location = In the basement
24        accept_redirects = yes
25        extraopts = -some-letter-the-author-did-not-think-of
26        ignore_cache = yes
27        ipversion = 4
28        pings = 5
29        port = 80
30        priority = 6
31        prot = 3443
32        revalidate_data = no
33        timeout = 20
34        tos = 0xa0
35        url = /
36        waittime = 1
37
38        # [...]
39
40        *** Targets ***
41
42        probe = EchoPingHttps # if this should be the default probe
43
44        # [...]
45
46        + mytarget
47        # probe = EchoPingHttps # if the default probe is something else
48        host = my.host
49        /^influx_.+/ = influx_location = In the basement
50        accept_redirects = yes
51        extraopts = -some-letter-the-author-did-not-think-of
52        ignore_cache = yes
53        ipversion = 4
54        pings = 5
55        port = 80
56        priority = 6
57        prot = 3443
58        revalidate_data = no
59        timeout = 20
60        tos = 0xa0
61        url = /
62        waittime = 1
63

DESCRIPTION

65       As EchoPingHttp(3pm), but SSL-enabled.
66

VARIABLES

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

AUTHORS

198       Niko Tyni <ntyni@iki.fi>
199

NOTES

201       You should consider setting a lower value for the "pings" variable than
202       the default 20, as repetitive URL fetching may be quite heavy on the
203       server.
204