test/apisix
1
0
Fork 0
mirror of https://gitee.com/iresty/apisix.git synced 2024-12-14 08:51:29 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity
f34459bdda
apisix/doc/plugins/limit-conn.md

89 lines
2.8 KiB
Markdown
Raw Normal View History

feature: implemented plugin `limit-conn`. (#75) * feature: implemented plugin `limit-conn`. * luarocks: updated the library `lua-resty-ngxvar` version to 0.3.
2019-06-11 17:31:40 +08:00
[中文](limit-conn-cn.md)
feature: added check for openresty version and fixed style of documents. (#244)
2019-07-14 09:32:22 +08:00
# limit-conn
feature: implemented plugin `limit-conn`. (#75) * feature: implemented plugin `limit-conn`. * luarocks: updated the library `lua-resty-ngxvar` version to 0.3.
2019-06-11 17:31:40 +08:00
Limiting request concurrency (or concurrent connections) plugin for Apisix.
### Parameters
* `conn`: is the maximum number of concurrent requests allowed. Requests exceeding this ratio (and below `conn` + `burst`) will get delayed to conform to this threshold.
* `burst`: is the number of excessive concurrent requests (or connections) allowed to be delayed.
* `default_conn_delay`: is the default processing latency of a typical connection (or request).
* `key`: is the user specified key to limit the concurrency level.
For example, one can use the host name (or server zone) as the key so that we limit concurrency per host name. Otherwise, we can also use the client address as the key so that we can avoid a single client from flooding our service with too many parallel connections or requests.
feature: support more key for limit-rate, limit-count, limit-conn (#444)
2019-08-27 18:29:42 +08:00
Now accept those as key: "remote_addr"(client's IP), "server_addr"(server's IP), "X-Forwarded-For/X-Real-IP" in request header.
feature: implemented plugin `limit-conn`. (#75) * feature: implemented plugin `limit-conn`. * luarocks: updated the library `lua-resty-ngxvar` version to 0.3.
2019-06-11 17:31:40 +08:00
* `rejected_code`: The HTTP status code returned when the request exceeds the threshold is rejected. The default is 503.
#### enable plugin
Here's an example, enable the limit-conn plugin on the specified route:
```shell
doc(v0.5): set the configuration with admin API (#125) * doc: set the configuration with admin API, except plugin `key-auth`. Fix #124
2019-06-18 09:40:00 +08:00
curl http://127.0.0.1:9080/apisix/admin/routes/1 -X PUT -d '
feature: implemented plugin `limit-conn`. (#75) * feature: implemented plugin `limit-conn`. * luarocks: updated the library `lua-resty-ngxvar` version to 0.3.
2019-06-11 17:31:40 +08:00
{
"methods": ["GET"],
"uri": "/index.html",
feature: changed plugin_config to plugins. (#84)
2019-06-13 17:25:39 +08:00
"plugins": {
feature: implemented plugin `limit-conn`. (#75) * feature: implemented plugin `limit-conn`. * luarocks: updated the library `lua-resty-ngxvar` version to 0.3.
2019-06-11 17:31:40 +08:00
"limit-conn": {
"conn": 1,
"burst": 0,
"default_conn_delay": 0.1,
"rejected_code": 503,
"key": "remote_addr"
}
},
"upstream": {
"type": "roundrobin",
"nodes": {
"39.97.63.215:80": 1
}
}
}'
```
#### test plugin
The parameters of the plugin enabled above indicate that only one concurrent request is allowed. When more than one concurrent request is received, will return `503` directly.
```shell
curl -i http://127.0.0.1:9080/index.html?sleep=20 &
curl -i http://127.0.0.1:9080/index.html?sleep=20
<html>
<head><title>503 Service Temporarily Unavailable</title></head>
<body>
<center><h1>503 Service Temporarily Unavailable</h1></center>
<hr><center>openresty</center>
</body>
</html>
```
This means that the limit request concurrency plugin is in effect.
#### disable plugin
When you want to disable the limit-conn plugin, it is very simple,
you can delete the corresponding json configuration in the plugin configuration,
no need to restart the service, it will take effect immediately:
```shell
doc(v0.5): set the configuration with admin API (#125) * doc: set the configuration with admin API, except plugin `key-auth`. Fix #124
2019-06-18 09:40:00 +08:00
curl http://127.0.0.1:9080/apisix/admin/routes/1 -X PUT -d '
feature: implemented plugin `limit-conn`. (#75) * feature: implemented plugin `limit-conn`. * luarocks: updated the library `lua-resty-ngxvar` version to 0.3.
2019-06-11 17:31:40 +08:00
{
"methods": ["GET"],
"uri": "/index.html",
"id": 1,
feature: changed plugin_config to plugins. (#84)
2019-06-13 17:25:39 +08:00
"plugins": {
feature: implemented plugin `limit-conn`. (#75) * feature: implemented plugin `limit-conn`. * luarocks: updated the library `lua-resty-ngxvar` version to 0.3.
2019-06-11 17:31:40 +08:00
},
"upstream": {
"type": "roundrobin",
"nodes": {
"39.97.63.215:80": 1
}
}
}'
```
The limit-conn plugin has been disabled now. It works for other plugins.
Reference in New Issue Copy Permalink