Firstsawyou commented on a change in pull request #3456: URL: https://github.com/apache/apisix/pull/3456#discussion_r566721963
##########
File path: doc/plugins/limit-conn.md
##########
@@ -35,11 +35,11 @@ Limiting request concurrency plugin.
| Name | Type | Requirement | Default | Valid
| Description
|
| ------------------ | ------- | ----------- | ------- |
------------------------------------------------------------------------ |
---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
|
-| conn | integer | required | | [0,...]
| the maximum number of
concurrent requests allowed. Requests exceeding this ratio (and below `conn` +
`burst`) will get delayed to conform to this threshold.
|
-| burst | integer | required | | [0,...]
| the number of excessive
concurrent requests (or connections) allowed to be delayed.
|
-| default_conn_delay | number | required | | [0,...]
| the default processing
latency of a typical connection (or request).
|
+| conn | integer | required | | conn > 0
| the maximum number of
concurrent requests allowed. Requests exceeding this ratio (and below `conn` +
`burst`) will get delayed to conform to this threshold.
|
+| burst | integer | required | | burst >= 0
| the number of excessive
concurrent requests (or connections) allowed to be delayed.
|
+| default_conn_delay | number | required | | default_conn_delay >
0 | the default processing
latency of a typical connection (or request).
|
| key | object | required | | ["remote_addr",
"server_addr", "http_x_real_ip", "http_x_forwarded_for", "consumer_name"] | to
limit the concurrency level. <br>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. <br> Now accept those as key: "remote_addr"(client's IP),
"server_addr"(server's IP), "X-Forwarded-For/X-Real-IP" in request header,
"consumer_name"(consumer's username). |
-| rejected_code | string | optional | 503 | [200,...]
| returned when the request
exceeds `conn` + `burst` will be rejected.
|
+| rejected_code | string | optional | 503 | [200,...,600]
| returned when the
request exceeds `conn` + `burst` will be rejected.
|
Review comment:
updated.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
[email protected]
