Quick navigation
Limit Connection Policy
Introduction
Limit connection policy limits connection attempts within a second because creating a new connection is expensive.
If connection attempts hit more than limitation in specific duration, it will respond PolicyViolationException
.
Configuration
key | type | default | description |
---|---|---|---|
maximumConnectionsPerSecond | int | Maximum connections which is allowed within a second | |
action | Action | BLOCK | Action to take if the value is outside the specified range. |
throttleTimeMs | int | 100 | Value to throttle with (only applicable when action is set to THROTTLE ). |
Action
BLOCK
→ when fail, save in audit and return error.INFO
→ execute API with wrong value, save in audit.THROTTLE
→ when fail, save in audit and the request will be throttled with time =throttleTimeMs
.
Example
{
"name": "myLimitConnectionPolicyPlugin",
"pluginClass": "io.conduktor.gateway.interceptor.safeguard.LimitConnectionPolicyPlugin",
"priority": 100,
"config": {
"maximumConnectionsPerSecond": 5,
"action": "BLOCK"
}
}