The wso2throttle module is for controlling controls client access to web Web service engine. Using the management console of a Carbon server, you can enable access throttling at global level, operational level or service level.
| Info |
|---|
For instructions on enabling access throttling at a service level or operational level, refer to sections "Service Management -> Access Throttling" and "Service Management -> Operation Management." |
Follow the instructions below to configure the wso2throttle module on a global level.
1. In the Deployed Modules page, click on the Configure link associated with the wso2throttle module.
2. The Global Throttling Configuration page appears. In the Enable Throttling list, select Yes from the drop-down menu.
3. The existing throttle configuration appears in the wizard as shown in the example below. Click Add New Entry.
...
. The steps below show how to configure the wso2throttle module.
- Log in to the product's management console and select List under Modules.
- In the Deployed Modules page, click the Configure link associated with the wso2throttle module. For example,
- The Global Throttling Configuration page opens. Select Yes from Enable Throttling drop-down list to enable the module.
- 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.
- Control : Allows to modify the parameter.
Info When the Access drop-down list is set to
AlloworDeny, the MRC, UT and PTP parameters are
...
deactivated. If it isset 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)