You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@apisix.apache.org by "ashruthg (via GitHub)" <gi...@apache.org> on 2026/02/28 15:21:46 UTC
[PR] docs: add stream proxy example for limit-conn plugin (#4933) [apisix]
ashruthg opened a new pull request, #13052:
URL: https://github.com/apache/apisix/pull/13052
Add a stream proxy usage example to the limit-conn plugin documentation.
--
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: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] docs: add stream proxy example for limit-conn plugin (#4933) [apisix]
Posted by "github-actions[bot] (via GitHub)" <gi...@apache.org>.
github-actions[bot] closed pull request #13052: docs: add stream proxy example for limit-conn plugin (#4933)
URL: https://github.com/apache/apisix/pull/13052
--
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: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] docs: add stream proxy example for limit-conn plugin (#4933) [apisix]
Posted by "github-actions[bot] (via GitHub)" <gi...@apache.org>.
github-actions[bot] commented on PR #13052:
URL: https://github.com/apache/apisix/pull/13052#issuecomment-4470309894
This pull request has been marked as stale due to 60 days of inactivity. It will be closed in 4 weeks if no further activity occurs. If you think that's incorrect or this pull request should instead be reviewed, please simply write any comment. Even if closed, you can still revive the PR at any time or discuss it on the dev@apisix.apache.org list. Thank you for your contributions.
--
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: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] docs: add stream proxy example for limit-conn plugin (#4933) [apisix]
Posted by "Baoyuantop (via GitHub)" <gi...@apache.org>.
Baoyuantop commented on code in PR #13052:
URL: https://github.com/apache/apisix/pull/13052#discussion_r2871640494
##########
docs/en/latest/plugins/limit-conn.md:
##########
@@ -425,3 +425,22 @@ Response: 429
```
This shows the two routes configured in different APISIX instances share the same quota.
+
+## Use limit-conn in Stream Proxy
+
+The `limit-conn` plugin can also be used in stream proxy mode.
+
+Example configuration for stream proxy:
+
+```json
Review Comment:
It would be best to provide a complete curl example.
--
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: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] docs: add stream proxy example for limit-conn plugin (#4933) [apisix]
Posted by "github-actions[bot] (via GitHub)" <gi...@apache.org>.
github-actions[bot] commented on PR #13052:
URL: https://github.com/apache/apisix/pull/13052#issuecomment-4701538895
This pull request/issue has been closed due to lack of activity. If you think that is incorrect, or the pull request requires review, you can revive the PR at any time.
--
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: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] docs: add stream proxy example for limit-conn plugin (#4933) [apisix]
Posted by "Copilot (via GitHub)" <gi...@apache.org>.
Copilot commented on code in PR #13052:
URL: https://github.com/apache/apisix/pull/13052#discussion_r2922580863
##########
docs/en/latest/plugins/limit-conn.md:
##########
@@ -425,3 +425,22 @@ Response: 429
```
This shows the two routes configured in different APISIX instances share the same quota.
+
+## Use limit-conn in Stream Proxy
+
+The `limit-conn` plugin can also be used in stream proxy mode.
+
+Example configuration for stream proxy:
+
+```json
+{
+ "plugins": {
+ "limit-conn": {
+ "conn": 1,
+ "burst": 0,
+ "default_conn_delay": 0.1,
+ "key": "remote_addr"
+ }
+ }
+}
+When used in stream proxy mode, only remote_addr and server_addr can be used as the key.
Review Comment:
The JSON example code block isn’t closed, so the following sentence is rendered as part of the JSON snippet. Add a closing ``` after the JSON and keep the explanatory sentence outside the code block.
##########
docs/en/latest/plugins/limit-conn.md:
##########
@@ -425,3 +425,22 @@ Response: 429
```
This shows the two routes configured in different APISIX instances share the same quota.
+
+## Use limit-conn in Stream Proxy
+
+The `limit-conn` plugin can also be used in stream proxy mode.
+
+Example configuration for stream proxy:
+
+```json
+{
+ "plugins": {
+ "limit-conn": {
+ "conn": 1,
+ "burst": 0,
+ "default_conn_delay": 0.1,
+ "key": "remote_addr"
+ }
+ }
+}
Review Comment:
This “stream proxy” example isn’t directly actionable as-written because it only shows a partial object. Stream plugin configuration is typically demonstrated as a full `stream_route` Admin API payload (including an `upstream`) so users can copy/paste it to `/apisix/admin/stream_routes/...`. Consider expanding the example accordingly (similar to other stream plugin docs).
##########
docs/en/latest/plugins/limit-conn.md:
##########
@@ -425,3 +425,22 @@ Response: 429
```
This shows the two routes configured in different APISIX instances share the same quota.
+
+## Use limit-conn in Stream Proxy
+
+The `limit-conn` plugin can also be used in stream proxy mode.
+
+Example configuration for stream proxy:
+
+```json
+{
+ "plugins": {
+ "limit-conn": {
+ "conn": 1,
+ "burst": 0,
+ "default_conn_delay": 0.1,
+ "key": "remote_addr"
+ }
+ }
+}
+When used in stream proxy mode, only remote_addr and server_addr can be used as the key.
Review Comment:
The note “only remote_addr and server_addr can be used as the key” doesn’t match the stream plugin behavior: `limit-conn` in stream mode reads `key` from `ctx.var[key]` (or resolves `var_combination`), so any available Nginx stream variable can be used (e.g. `server_port` as well). Please correct or relax this statement to avoid documenting an incorrect restriction.
```suggestion
When used in stream proxy mode, the `key` is taken from Nginx stream variables (for example, `remote_addr`, `server_addr`, or `server_port`), so any available stream variable can be used.
```
--
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: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org