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 suceeeds.
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        deny_re = Access Prohibited
32        more_hosts = www.playboy.com, www.our-competition.com
33        pings = 5
34        timeout = 2
35
36        # [...]
37
38        *** Targets ***
39
40        probe = WebProxyFilter # if this should be the default probe
41
42        # [...]
43
44        + mytarget
45        # probe = WebProxyFilter # if the default probe is something else
46        host = my.host
47        deny_re = Access Prohibited
48        more_hosts = www.playboy.com, www.our-competition.com
49        pings = 5
50        timeout = 2
51

DESCRIPTION

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

VARIABLES

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

AUTHORS

161       Tobias Oetiker <tobi@oetiker.ch> sponsored by Virtela
162

BUGS

164       This probe is somewhat unortodox, since it regards the sucessful
165       retrieval of a banned webpage as a loss.
166
167
168
1692.7.3                             2021-07-23Smokeping_probes_WebProxyFilter(3)
Impressum