Configuring the wso2throttle Module

The wso2throttle module controls client access to Web service engine. The steps below show how to configure the wso2throttle module.

1. Log in to the product's management console and select List under Modules.
2. In the Deployed Modules page, click the Configure link associated with the wso2throttle module. For example,
   
3. The Global Throttling Configuration page opens. Select Yes from Enable Throttling drop-down list to enable the module.
4. T he existing throttle configuration opens where you can edit existing parameters or add new ones. For example,
   To enter new parameters or modify existing parameters, select Control in the Access column.   
   Specify the parameters of a service. Parameter fields are explained below:
   
   • Range : The IP address range that the domain is restricted from accessing the service. Requests from such clients are restricted based on the specified values.
   • Type : The type of the range. It can be IP or DOMAIN. It should be IP if the range is given as a single or a range of IP addresses (e.g., 10.100.1.30-10.100.1.60). It should be DOMAIN if the range is given as as a domain (e.g.,, *.wso2.com). If you specify configuration types of both IP and DOMAIN, first priority will be given to DOMAIN level configurations.
   • Maximum Request Count (MRC) : If the Access drop-down is set to Control, it will be the maximum number of requests that is served within the time interval specified in the Unit Time parameter.
   • Unit Time (UT) : The time period in milliseconds during which the maximum requests are served. This is the number specified by the Maximum Request Count. The throttle starts counting the number of units from the moment it is enabled and the number of requests served within that period.
   • Prohibit Time Period (PTP) : If the maximum request count is achieved before the unit time, this is the period during which no more requests are allowed to go in. By setting this value, the unit time slot is altered.
   • Access
     •   Allow : Means that no restriction is applied for that range and all requests are allowed to go in as they come in.
     •   Deny : Means that access is completely denied for that range.
     •   Control : Allows to modify the parameter. 
       

   When the Access drop-down list is set to Allow or Deny, the MRC, UT and PTP parameters are deactivated. If it is set to Control, the specified constraints are applied for that particular range.

   • Actions  : Allows to delete a parameter.

   Let's see how these parameters work using an example:

   Example:   MRC = 50, UT = 50000, PTP = 5000

   This means that if 50 requests are arrived within 35000ms (35s) in a particular time period, no more requests are taken in for another 5000ms (5s = PTP). This time the UT is altered to 35000ms + 5000ms = 40000ms (40s)