apache/apisix

docs: limit-conn plugin in stream proxy

Open

Aperta il 30 ago 2021

Vedi su GitHub
 (14 commenti) (0 reazioni) (0 assegnatari)Lua (16.597 star) (2860 fork)batch import
docgood first issue

Descrizione

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.

Guida contributor

Tech stack
Nessuno
Dominio
documentation
Tipo issue
documentation
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-3 hours
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
stale
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
clear
Prerequisiti
APISIX basicslimit conn plugin concept
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
85
Direzione di ricerca
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.