Proxy¶
ProxyI es la capa de reverse proxy y virtual host routing de WSBuilder.
Cuadro general¶
- enruta por host, path, metodos y headers
- balancea entre varios targets
- preserva o reescribe host segun la regla
- expone snapshot, dashboard y metricas
Crear reglas¶
from wsbuilder import ProxyI
proxy = ProxyI(name="edge")
proxy.vhost("api.test.local", name="api-vhost").location("/api").upstream("http://127.0.0.1:9000").build()
DSL de reglas¶
ProxyRouteBuilder permite componer filtros:
host(),host_contains(),host_regex()path(),path_prefix(),path_contains(),path_regex()header(),header_equals(),header_contains()balance(),priority(),default()strip_prefix()ypreserve_host()
Targets¶
ProxyTarget representa un upstream:
urlnameweightprioritytimeout_secondsverify_tlsextra_headers
Seguridad y limites de respuesta¶
ProxyI acepta estas opciones al construirse:
| Opcion | Defecto | Efecto |
|---|---|---|
max_request_body_bytes |
8 MiB |
Un cuerpo de peticion mayor recibe 413. |
max_response_bytes |
16 MiB |
Un cuerpo de upstream con buffer mayor recibe 502. |
response_timeout_seconds |
30.0 |
Plazo total para leer un cuerpo con buffer; si se agota, 504. |
expose_upstream_header |
False |
Con True anade X-ProxyI-Upstream con la URL interna del upstream. |
- Un path con segmentos
.o.., literales o codificados (%2e,%2f,%5c, tambien..;param), se rechaza con400antes de evaluar reglas, para que no escape de un prefijo ni delbase_pathdel target. - Las respuestas con
Content-Lengthse leen con buffer bajo esos dos limites. Si el upstream cierra antes de entregar la longitud declarada, se responde502. Las respuestaschunked, delimitadas por el cierre de la conexion otext/event-streamse retransmiten comoResponse.streampor bloques, sin cargarlas en memoria. En ese modo no hay plazo total ni limite de bytes: cada lectura respetatimeout_secondsdel target, de modo que un upstream que sigue enviando datos (por ejemplo SSE) mantiene ocupado el worker mientras dure. - Se conservan todos los
Set-Cookiedel upstream: las cabeceras repetidas llegan aResponse.headerscomo lista. X-ProxyI-Upstreamya no se envia por defecto;X-ProxyI-RuleyX-ProxyI-Targetse mantienen.
Balanceo¶
Estrategias disponibles:
round_robinweighted_round_robinrandomleast_connectionsleast_response_timeleast_requestsleast_bytes_inleast_bytes_outip_hashconsistent_hashfirst_availablepower_of_two_choicesbest
Ejemplo con headers¶
proxy.route(name="lb", path_prefix="/api", balance="least_response_time") \
.header("x-env", equals="prod") \
.upstream("http://127.0.0.1:9001", name="backend-1") \
.upstream("http://127.0.0.1:9002", name="backend-2") \
.build()
Dashboard¶
ProxyI trae una zona interna de dashboard y metricas:
dashboard_pathmetrics_pathmetrics_stream_path
Tambien puedes montar la instancia sobre un App con proxy.install(app).
El dashboard y las metricas muestran los upstreams y su estado, asi que por
defecto solo responden a loopback y redes privadas. Ajustalo con
ProxyI(access="*"), ProxyI(access=["10.0.0.0/8"], token="..."),
ProxyI(authorize=funcion) o los mismos argumentos en install_proxyi(...).
El codigo esta repartido en wsbuilder.proxyi._common, stats, routing y
core, pero todo se sigue importando desde wsbuilder.proxyi.
Snapshot¶
proxy.snapshot() devuelve:
- reglas
- targets
- contadores globales
- estado por target y por regla
Eso hace mas facil diagnosticar por que una regla selecciona un backend concreto.