Struct PingoraConfig 

#[non_exhaustive]
pub struct PingoraConfig {

    pub enabled: bool,
    pub bind: String,
    pub fallback: Fallback,
    pub trusted_proxies: Vec<String>,
    pub connect_timeout_ms: u64,
    pub read_timeout_ms: u64,
    pub write_timeout_ms: u64,
    pub max_retries: usize,
    pub health_check_interval_ms: u64,
    pub health_check_timeout_ms: u64,
    pub max_request_body_bytes: u64,
    pub max_connections: usize,
    pub max_connections_per_ip: usize,
    pub shutdown_grace_ms: u64,
    pub metrics: bool,
    pub routes: Vec<Route>,
}

Settings for the proxy.

For a setting that says “0: off”, the value 0 removes that limit.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

enabled: bool

Start the proxy. Default: true.

bind: String

Listen address, IP:port. Port 0 picks a free port. Empty: the profile decides. dev and test use 127.0.0.1:8080. Other profiles use 0.0.0.0:8080. Default: empty.

fallback: Fallback

Where unmatched requests go: app (the Autumn app) or none (404). Default: app.

trusted_proxies: Vec<String>

Peers (IPs or CIDR ranges) whose X-Forwarded-* and other identity headers the proxy keeps. For other peers, the proxy replaces them. Put only your own load balancers here. Default: empty.

connect_timeout_ms: u64

Upstream connect timeout. Must be more than 0. Default: 5000.

read_timeout_ms: u64

Upstream read timeout. 0: off. Default: 60000.

write_timeout_ms: u64

Upstream write timeout. 0: off. Default: 60000.

max_retries: usize

Connect retries on another upstream. Pingora also retries an idempotent request once or twice when a pooled connection is stale. Default: 1.

health_check_interval_ms: u64

Upstream TCP health check interval. 0: off. Default: 5000.

health_check_timeout_ms: u64

Health check connect timeout. Must be more than 0. Default: 1000.

max_request_body_bytes: u64

Largest request body. Bigger requests get 413. 0: off. Default: 10485760 (10 MiB).

max_connections: usize

Maximum open client connections. At the limit, the proxy stops accepting until a connection closes. 0: no limit. At most 1000000. Default: 10000.

max_connections_per_ip: usize

Maximum open connections from one client IP. The proxy closes connections over the limit at once. Keep 0 behind a load balancer, because all connections then have its IP. 0: no limit. Default: 0.

shutdown_grace_ms: u64

Time for open requests to finish at shutdown. Must be more than 0. The plugin caps it to fit server.shutdown_timeout_secs. Default: 10000.

metrics: bool

Record pingora_proxy_* metrics. Default: true.

routes: Vec<Route>

The routes. Env: AUTUMN_PINGORA__ROUTES replaces all routes with a TOML array.

Implementations

impl PingoraConfig

pub fn bind_addr(&self, development: bool) -> Result<SocketAddr, ConfigError>

The listen address. An empty bind gives 127.0.0.1:8080 in development and 0.0.0.0:8080 in other profiles.

Errors

Returns ConfigError when bind is not IP:port.

pub const fn connect_timeout(&self) -> Duration

Upstream connect timeout.

pub const fn read_timeout(&self) -> Option<Duration>

Upstream read timeout.

pub const fn write_timeout(&self) -> Option<Duration>

Upstream write timeout.

pub const fn health_check_interval(&self) -> Option<Duration>

Health check interval.

pub const fn health_check_timeout(&self) -> Duration

Health check connect timeout.

pub const fn shutdown_grace(&self) -> Duration

Shutdown grace period.

pub fn from_toml_str(text: &str, section: &str) -> Result<Self, ConfigError>

Parse [section] from a whole autumn.toml text. No profiles and no environment.

Errors

Returns ConfigError for bad TOML, unknown keys, wrong types or values that validate rejects.

pub fn resolve(section: &str) -> Result<Resolved, ConfigError>

Resolve [section] from the app’s files and the process environment.

Errors

Returns ConfigError when a file cannot be read or parsed, or when the merged section is not valid.

pub fn resolve_with_env( section: &str, env: &dyn Env, ) -> Result<Resolved, ConfigError>

Like resolve, but reads only env.

Errors

See resolve.

pub fn validate(&self) -> Result<(), ConfigError>

Reject values that fail at runtime.

Errors

Returns ConfigError that names the bad key.

Trait Implementations

impl Clone for PingoraConfig

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for PingoraConfig

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for PingoraConfig

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for PingoraConfig

where PingoraConfig: Default,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for PingoraConfig

impl PartialEq for PingoraConfig

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for PingoraConfig

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for PingoraConfig