apache/apisix

docs: limit-conn plugin in stream proxy

Open

#4,933 创建于 2021年8月30日

在 GitHub 查看
 (14 评论) (0 反应) (0 负责人)Lua (16,597 star) (2,860 fork)batch import
docgood first issue

描述

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.

贡献者指南

技术栈
无
领域
documentation
议题类型
documentation
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
2
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1-3 hours
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
stale
清晰度议题是否清楚说明期望改动、验收标准和下一步。
clear
前置要求
APISIX basicslimit conn plugin concept
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
85
研究方向
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.