kayx23 commented on code in PR #10866: URL: https://github.com/apache/apisix/pull/10866#discussion_r1475339270
##########
docs/en/latest/plugins/limit-conn.md:
##########
@@ -32,17 +32,30 @@ The `limit-conn` Plugin limits the number of concurrent
requests to your service
## Attributes
-| Name | Type | Required | Default | Valid values
| Description
|
-| ---------------------- | ------- | -------- | ------- |
-------------------------- |
-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------
|
-| conn | integer | True | | conn > 0
| Maximum number of concurrent requests allowed. Requests exceeding this
ratio (and below `conn` + `burst`) will be delayed (configured by
`default_conn_delay`).
|
-| burst | integer | True | | burst >= 0
| Number of additional concurrent requests allowed to be delayed per
second. If the number exceeds this hard limit, they will get rejected
immediately.
|
-| default_conn_delay | number | True | | default_conn_delay >
0 | Delay in seconds to process the concurrent requests exceeding `conn`
(and `conn` + `burst`).
|
-| only_use_default_delay | boolean | False | false | [true,false]
| When set to `true`, the Plugin will always set a delay of
`default_conn_delay` and would not use any other calculations.
|
-| key_type | string | False | "var" | ["var",
"var_combination"] | Type of user specified key to use.
|
-| key | string | True | |
| User specified key to base the request limiting on. If the `key_type`
attribute is set to `"var"`, the key will be treated as a name of variable,
like `remote_addr` or `consumer_name`. If the `key_type` is set to
`"var_combination"`, the key will be a combination of variables, like
`$remote_addr $consumer_name`. If the value of the key is empty, `remote_addr`
will be set as the default key. |
-| rejected_code | string | False | 503 | [200,...,599]
| HTTP status code returned when the requests exceeding the threshold are
rejected.
|
-| rejected_msg | string | False | | non-empty
| Body of the response returned when the requests exceeding the threshold
are rejected.
|
-| allow_degradation | boolean | False | false |
| When set to `true` enables Plugin degradation when the Plugin is
temporarily unavailable and allows requests to continue.
|
+| Name | Type | Required | Default | Valid values
| Description
|
+|--------------------------|---------| --------
|-------------|-----------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| conn | integer | True | | conn > 0
| Maximum number of concurrent requests allowed. Requests
exceeding this ratio (and below `conn` + `burst`) will be delayed (configured
by `default_conn_delay`).
|
+| burst | integer | True | | burst >= 0
| Number of additional concurrent requests allowed to be
delayed per second. If the number exceeds this hard limit, they will get
rejected immediately.
|
+| default_conn_delay | number | True | |
default_conn_delay > 0 | Delay in seconds to process the concurrent
requests exceeding `conn` (and `conn` + `burst`).
|
+| only_use_default_delay | boolean | False | false | [true,false]
| When set to `true`, the Plugin will always set a delay of
`default_conn_delay` and would not use any other calculations.
|
+| key_type | string | False | "var" | ["var",
"var_combination"] | Type of user specified key to use.
|
+| key | string | True | |
| User specified key to base the request limiting on. If the
`key_type` attribute is set to `"var"`, the key will be treated as a name of
variable, like `remote_addr` or `consumer_name`. If the `key_type` is set to
`"var_combination"`, the key will be a combination of variables, like
`$remote_addr $consumer_name`. If the value of the key is empty, `remote_addr`
will be set as the default key. |
+| rejected_code | string | False | 503 | [200,...,599]
| HTTP status code returned when the requests exceeding the
threshold are rejected.
|
+| rejected_msg | string | False | | non-empty
| Body of the response returned when the requests exceeding
the threshold are rejected.
|
+| allow_degradation | boolean | False | false |
| When set to `true` enables Plugin degradation when the
Plugin is temporarily unavailable and allows requests to continue.
|
+| policy | string | False | local | local, redis,
redis-cluster | counter type to choose local, redis or redis-cluster
|
Review Comment:
the description could be a bit more descriptive for `policy` like
[limit-count's](https://apisix.apache.org/docs/apisix/plugins/limit-count) doc?
--
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.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
