apache/apisix

docs: limit-conn plugin in stream proxy

Open

#4,933 opened on Aug 30, 2021

View on GitHub
 (14 comments) (0 reactions) (0 assignees)Lua (16,597 stars) (2,860 forks)batch import
docgood first issue

Description

Improved or typo fixed.

Currently, the limit-conn is supported in the stream proxy, but the documentation about limit-conn doesn't give a good example to show how to use it in stream proxy.

Documentation link: http://apisix.apache.org/docs/apisix/plugins/limit-conn.

Solution

We may add an example for how to use limit-conn in the stream proxy.

Contributor guide

Tech stack
None
Domain
documentation
Issue type
documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
APISIX basicslimit conn plugin concept
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85
Research direction
Review the existing limit conn documentation at http://apisix.apache.org/docs/apisix/plugins/limit conn, noting the current lack of stream proxy example. Examine the stream proxy configuration format used in other plugin documentation (e.g., limit req) for consistency. Investigate the plugin's source code to understand the configuration parameters relevant to stream proxy. Based on that, craft an example that shows how to configure limit conn for a stream route, including the necessary attributes and values.