Skip to main content

Crate synapse_proxy

Crate synapse_proxy 

Source
Expand description

synapse-proxy library surface (used by the binary and integration tests).

Re-exports§

pub use builder::ProxyBuilder;

Modules§

admin
Admin surface (separate listener): push/clear the context overlay.
builder
Compile parsed config + a transform registry into ready-to-serve routes. The binary uses built-ins only; library consumers register custom transforms by name before build().
config
Proxy config: listeners, context sources, and routes with transform steps.
context
Re-export of the shared synapse-context crate.
health
Liveness/readiness probes. Readiness flips to 503 once shutdown begins so load balancers drain this instance before in-flight requests finish.
http_client
metrics
OpenTelemetry metrics exported in Prometheus text format on /metrics.
proxy
Reverse-proxy pipeline: match (path_prefix + methods) → resolve context (gate require_context) → request transforms → forward (stream/hop-by-hop/cap) → response transforms → stream/replace.
transform
The transform pipeline: traits a request/response step implements, the mutable request/response views they operate on, and the registry of code-registered custom transforms.

Functions§

build_router
build_router_from_config
Build the data-plane router from a builder (used by integration tests).