pike(k): add parameter unit, reported from dirtytoni at gmx dot de
authorHenning Westerholt <hw@kamailio.org>
Tue, 27 Sep 2011 08:02:50 +0000 (10:02 +0200)
committerHenning Westerholt <hw@kamailio.org>
Tue, 27 Sep 2011 08:02:50 +0000 (10:02 +0200)
modules_k/pike/README
modules_k/pike/doc/pike_admin.xml

index 394cf96..99c0634 100644 (file)
@@ -107,8 +107,8 @@ Chapter 1. Admin Guide
 
 3.1. sampling_time_unit (integer)
 
-   Time period used for sampling (or the sampling accuracy ;-) ). The
-   smaller the better, but slower. If you want to detect peeks, use a
+   Time period in seconds used for sampling (or the sampling accuracy).
+   The smaller the better, but slower. If you want to detect peeks, use a
    small one. To limit the access (like total number of requests on a long
    period of time) to a proxy resource (a gateway for ex), use a bigger
    value of this parameter.
@@ -140,12 +140,12 @@ modparam("pike", "reqs_density_per_unit", 30)
 3.3. remove_latency (integer)
 
    For how long the IP address will be kept in memory after the last
-   request from that IP address. It's a sort of timeout value. Note that
-   it is not the duration to keep the IP in state 'blocked'. An IP is
-   unblocked next occurence of 'sampling_time_unit' that does not exceed
-   'reqs_density_per_unit'. Keeping an IP in memory results in faster
-   reaching of blocked state -- see the notes about the limits of getting
-   to state 'blocked'.
+   request from that IP address. It's a sort of timeout value, in seconds.
+   Note that it is not the duration to keep the IP in state 'blocked'. An
+   IP is unblocked next occurence of 'sampling_time_unit' that does not
+   exceed 'reqs_density_per_unit'. Keeping an IP in memory results in
+   faster reaching of blocked state -- see the notes about the limits of
+   getting to state 'blocked'.
 
    Default value is 120.
 
index 3b72316..89d9f27 100644 (file)
@@ -61,9 +61,9 @@
        <section>
                <title><varname>sampling_time_unit</varname> (integer)</title>
                <para>
-               Time period used for sampling (or the sampling accuracy ;-) ). The 
-               smaller the better, but slower. If you want to detect peeks, use a 
-               small one. To limit the access (like total number of requests on a 
+               Time period in seconds used for sampling (or the sampling accuracy).
+               The smaller the better, but slower. If you want to detect peeks, use
+               small one. To limit the access (like total number of requests on a 
                long period of time) to a proxy resource (a gateway for ex), use 
                a bigger value of this parameter.
                </para>
@@ -111,12 +111,12 @@ modparam("pike", "reqs_density_per_unit", 30)
                <title><varname>remove_latency</varname> (integer)</title>
                <para>
                For how long the IP address will be kept in memory after the last 
-               request from that IP address. It's a sort of timeout value. Note that
-               it is not the duration to keep the IP in state 'blocked'. An IP is
-               unblocked next occurence of 'sampling_time_unit' that does not exceed
-               'reqs_density_per_unit'. Keeping an IP in memory results in faster
-               reaching of blocked state -- see the notes about the limits of getting
-               to state 'blocked'.
+               request from that IP address. It's a sort of timeout value, in seconds.
+               Note that it is not the duration to keep the IP in state 'blocked'. An
+               IP is unblocked next occurence of 'sampling_time_unit' that does not
+               exceed 'reqs_density_per_unit'. Keeping an IP in memory results in
+               faster reaching of blocked state -- see the notes about the limits of
+               getting to state 'blocked'.
                </para>
                <para>
                <emphasis>