1Smokeping_probes_EchoPingHttp(3)   SmokePing  Smokeping_probes_EchoPingHttp(3)
2
3
4

NAME

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

OVERVIEW

9       Measures HTTP roundtrip times (web servers and caches) for SmokePing.
10

SYNOPSIS

12        *** Probes ***
13
14        +EchoPingHttp
15
16        binary = /usr/bin/echoping
17        forks = 5
18        offset = 50%
19        step = 300
20
21        # The following variables can be overridden in each target section
22        /^influx_.+/ = influx_location = In the basement
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        revalidate_data = no
31        timeout = 20
32        tos = 0xa0
33        url = /
34        waittime = 1
35
36        # [...]
37
38        *** Targets ***
39
40        probe = EchoPingHttp # if this should be the default probe
41
42        # [...]
43
44        + mytarget
45        # probe = EchoPingHttp # if the default probe is something else
46        host = my.host
47        /^influx_.+/ = influx_location = In the basement
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        revalidate_data = no
56        timeout = 20
57        tos = 0xa0
58        url = /
59        waittime = 1
60

VARIABLES

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

AUTHORS

187       Niko Tyni <ntyni@iki.fi>
188

NOTES

190       You should consider setting a lower value for the "pings" variable than
191       the default 20, as repetitive URL fetching may be quite heavy on the
192       server.
193
194       The fill, size and udp EchoPing variables are not valid for
195       EchoPingHttp.
196

SEE ALSO

198       Smokeping::probes::EchoPing, Smokeping::probes::EchoPingHttps
199
200
201
2022.8.2                             2022-07-23  Smokeping_probes_EchoPingHttp(3)
Impressum