1Smokeping_probes_WebProxyFilter(3) SmokePingSmokeping_probes_WebProxyFilter(3)
2
3
4

NAME

6       Smokeping::probes::WebProxyFilter - tests webproxy filter performance
7       and function.
8

OVERVIEW

10       This probe tests if your filtering webproxy is working properly.
11       Drawing from a list of forbidden websites, it tries to establish a
12       connection to each one of them and registers a 'loss' when it succeeds.
13
14       If you want to test availability of a website, use the EchoPingHttp
15       probe.
16

SYNOPSIS

18        *** Probes ***
19
20        +WebProxyFilter
21
22        forks = 5
23        maxsize = 2000
24        min_interval = 0.1
25        offset = 50%
26        step = 300
27        timeout = 15
28        useragent = SmokePing/2.x (WebProxyFilter Probe)
29
30        # The following variables can be overridden in each target section
31        /^influx_.+/ = influx_location = In the basement
32        deny_re = Access Prohibited
33        more_hosts = www.playboy.com, www.our-competition.com
34        pings = 5
35        timeout = 2
36
37        # [...]
38
39        *** Targets ***
40
41        probe = WebProxyFilter # if this should be the default probe
42
43        # [...]
44
45        + mytarget
46        # probe = WebProxyFilter # if the default probe is something else
47        host = my.host
48        /^influx_.+/ = influx_location = In the basement
49        deny_re = Access Prohibited
50        more_hosts = www.playboy.com, www.our-competition.com
51        pings = 5
52        timeout = 2
53

DESCRIPTION

55       The probe uses the LWP::UserAgent module to retrieve a series of
56       webpages. It expects to get the firewalls 'site-prohibited' page. Any
57       other response (or a real loss) gets logged as a loss and can be used
58       to trigger an alarm.
59
60       The probe tries to be nice to the firewall and waits at least X seconds
61       between starting filetransfers, where X is the value of the probe
62       specific `min_interval' variable (1 by default).
63
64       Many variables can be specified either in the probe or in the target
65       definition, the target-specific variable will override the prove-
66       specific variable.
67

VARIABLES

69       Supported probe-specific variables:
70
71       forks
72           Run this many concurrent processes at maximum
73
74           Example value: 5
75
76           Default value: 5
77
78       maxsize
79           How much of the webpage should be retrieved.
80
81           Default value: 2000
82
83       min_interval
84           The minimum interval between each starting GETs in seconds.
85
86           Example value: 0.1
87
88           Default value: 1
89
90       offset
91           If you run many probes concurrently you may want to prevent them
92           from hitting your network all at the same time. Using the probe-
93           specific offset parameter you can change the point in time when
94           each probe will be run. Offset is specified in % of total interval,
95           or alternatively as 'random', and the offset from the 'General'
96           section is used if nothing is specified here. Note that this does
97           NOT influence the rrds itself, it is just a matter of when data
98           acquisition is initiated.  (This variable is only applicable if the
99           variable 'concurrentprobes' is set in the 'General' section.)
100
101           Example value: 50%
102
103       step
104           Duration of the base interval that this probe should use, if
105           different from the one specified in the 'Database' section. Note
106           that the step in the RRD files is fixed when they are originally
107           generated, and if you change the step parameter afterwards, you'll
108           have to delete the old RRD files or somehow convert them. (This
109           variable is only applicable if the variable 'concurrentprobes' is
110           set in the 'General' section.)
111
112           Example value: 300
113
114       timeout
115           How long a single 'ping' takes at maximum
116
117           Example value: 15
118
119           Default value: 5
120
121       useragent
122           The web browser we claim to be, just in case the FW is interested
123
124           Default value: SmokePing/2.x (WebProxyFilter Probe)
125
126       Supported target-specific variables:
127
128       /^influx_.+/
129           This is a tag that will be sent to influxdb and has no impact on
130           the probe measurement. The tag name will be sent without the
131           "influx_" prefix, which will be replaced with "tag_" instead. Tags
132           can be used for filtering.
133
134           Example value: influx_location = In the basement
135
136       deny_re
137           Regular expression, matching the 'deny' response from the firewall
138
139           Example value: Access Prohibited
140
141       more_hosts
142           A comma separated list of banned websites to test in addition to
143           the one specified in the host variable. The websites will be tested
144           one after the other in one round, this means that while normal
145           probes do run the same test several times in a row, this one will
146           alter the webpage with each round.  The reason for this is, that
147           even though we try to retrieve remote webpages, the answer will
148           come from the firewall every time, so we kill two birds in one go.
149           First we test the firewalls latency and second we make sure its
150           filter works properly.
151
152           Example value: www.playboy.com, www.our-competition.com
153
154       pings
155           How many pings should be sent to each target, if different from the
156           global value specified in the Database section. Note that the
157           number of pings in the RRD files is fixed when they are originally
158           generated, and if you change this parameter afterwards, you'll have
159           to delete the old RRD files or somehow convert them.
160
161           Example value: 5
162
163       timeout
164           Timeout in seconds for the test complete.
165
166           Example value: 2
167
168           Default value: 2
169

AUTHORS

171       Tobias Oetiker <tobi@oetiker.ch> sponsored by Virtela
172

BUGS

174       This probe is somewhat unortodox, since it regards the successful
175       retrieval of a banned webpage as a loss.
176
177
178
1792.8.2                             2022-07-23Smokeping_probes_WebProxyFilter(3)
Impressum