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.
docs: limit-conn plugin in stream proxy · apache/apisix#4933 | Good First Issue