Skip to main content

RuntimeConfig

Struct RuntimeConfig 

Source
pub struct RuntimeConfig {
    pub global_queue_interval: Option<u32>,
    pub log_overrides: HashMap<String, String>,
    pub max_connections: Option<u32>,
    pub max_memory_bytes: Option<usize>,
    pub threads: usize,
    pub upstream_ca_file: Option<String>,
    pub upstream_keepalive_pool_size: Option<usize>,
    pub work_stealing: bool,
}
Expand description

Configuration for the runtime of the proxy server.

use praxis_core::config::RuntimeConfig;

let cfg = RuntimeConfig::default();
assert_eq!(cfg.threads, 0);
assert!(cfg.work_stealing);
assert_eq!(cfg.global_queue_interval, Some(61));
assert!(cfg.log_overrides.is_empty());
assert_eq!(cfg.upstream_keepalive_pool_size, Some(64));
assert!(cfg.upstream_ca_file.is_none());

let cfg: RuntimeConfig = serde_yaml::from_str("threads: 4\nwork_stealing: true").unwrap();
assert_eq!(cfg.threads, 4);
assert!(cfg.work_stealing);

Fields§

§global_queue_interval: Option<u32>

Tokio scheduler global queue check interval, in ticks.

Controls how often worker threads check the global task queue. The default of 61 (a prime) reduces contention under proxy workloads where most tasks are I/O-bound. Set to null to use the tokio default. Valid range is any positive u32.

use praxis_core::config::RuntimeConfig;

let cfg = RuntimeConfig::default();
assert_eq!(cfg.global_queue_interval, Some(61));

let cfg: RuntimeConfig = serde_yaml::from_str("global_queue_interval: 128").unwrap();
assert_eq!(cfg.global_queue_interval, Some(128));
§log_overrides: HashMap<String, String>

Per-module log level overrides.

use praxis_core::config::RuntimeConfig;

let yaml = r#"
log_overrides:
  praxis_filter::pipeline: trace
  praxis_protocol: debug
"#;
let cfg: RuntimeConfig = serde_yaml::from_str(yaml).unwrap();
assert_eq!(cfg.log_overrides.len(), 2);
assert_eq!(cfg.log_overrides["praxis_filter::pipeline"], "trace");
§max_connections: Option<u32>

Process-wide maximum concurrent connections across all listeners (both HTTP and TCP).

When set, new connections beyond this limit are rejected with HTTP 503 (or TCP close for non-HTTP listeners), regardless of per-listener limits. Connections are shed before filter pipeline execution. None (the default) means no global limit.

use praxis_core::config::RuntimeConfig;

let cfg: RuntimeConfig = serde_yaml::from_str("max_connections: 10000").unwrap();
assert_eq!(cfg.max_connections, Some(10_000));

let cfg = RuntimeConfig::default();
assert!(cfg.max_connections.is_none());
§max_memory_bytes: Option<usize>

Maximum resident memory (RSS) in bytes before shedding load.

When set, Praxis monitors process RSS and rejects new requests with 503 when the threshold is exceeded. None (the default) disables memory pressure monitoring.

use praxis_core::config::RuntimeConfig;

let cfg: RuntimeConfig = serde_yaml::from_str("max_memory_bytes: 1073741824").unwrap();
assert_eq!(cfg.max_memory_bytes, Some(1_073_741_824));

let cfg = RuntimeConfig::default();
assert!(cfg.max_memory_bytes.is_none());
§threads: usize

Number of worker threads per service.

0 (the default) auto-detects based on available CPU cores. Values above the CPU count are valid but yield diminishing returns for I/O-bound workloads.

§upstream_ca_file: Option<String>

Path to a PEM CA file used as the root certificate store for all upstream TLS connections.

When set, this replaces the system trust store (not additive). If backends use both a private CA and public CAs, create a combined PEM bundle containing all required root certificates.

use praxis_core::config::RuntimeConfig;

let cfg: RuntimeConfig =
    serde_yaml::from_str("upstream_ca_file: /etc/praxis/ca-bundle.pem").unwrap();
assert_eq!(
    cfg.upstream_ca_file.as_deref(),
    Some("/etc/praxis/ca-bundle.pem")
);

let cfg = RuntimeConfig::default();
assert!(cfg.upstream_ca_file.is_none());
§upstream_keepalive_pool_size: Option<usize>

Maximum number of idle upstream connections kept per worker thread, shared across all clusters.

When a worker’s pool is full, the oldest idle connection is evicted. Set to null to use Pingora’s built-in default. This is a per-thread limit, not per-cluster.

use praxis_core::config::RuntimeConfig;

let cfg = RuntimeConfig::default();
assert_eq!(cfg.upstream_keepalive_pool_size, Some(64));

let cfg: RuntimeConfig = serde_yaml::from_str("upstream_keepalive_pool_size: 32").unwrap();
assert_eq!(cfg.upstream_keepalive_pool_size, Some(32));
§work_stealing: bool

Allow work-stealing between worker threads of the same service.

Trait Implementations§

Source§

impl Clone for RuntimeConfig

Source§

fn clone(&self) -> RuntimeConfig

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for RuntimeConfig

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for RuntimeConfig

Source§

fn default() -> Self

Returns the “default value” for a type. Read more
Source§

impl<'de> Deserialize<'de> for RuntimeConfig

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl From<&RuntimeConfig> for RuntimeOptions

Source§

fn from(cfg: &RuntimeConfig) -> Self

Converts to this type from the input type.
Source§

impl Serialize for RuntimeConfig

Source§

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

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<'a, T, E> AsTaggedExplicit<'a, E> for T
where T: 'a,

Source§

fn explicit(self, class: Class, tag: u32) -> TaggedParser<'a, Explicit, Self, E>

Source§

impl<'a, T, E> AsTaggedImplicit<'a, E> for T
where T: 'a,

Source§

fn implicit( self, class: Class, constructed: bool, tag: u32, ) -> TaggedParser<'a, Implicit, Self, E>

Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more