Struct RuntimeConfig

pub struct RuntimeConfig {
    pub workers: u16,
    pub storage: bool,
    pub fault_tolerance: Option<FtConfig>,
    pub cpu_profiler: bool,
    pub tracing: bool,
    pub tracing_endpoint_jaeger: String,
    pub min_batch_size_records: u64,
    pub max_buffering_delay_usecs: u64,
    pub resources: ResourceConfig,
    pub min_storage_bytes: Option<usize>,
    pub clock_resolution_usecs: Option<u64>,
}

Global pipeline configuration settings. This is the publicly exposed type for users to configure pipelines.

Fields

workers: u16

Number of DBSP worker threads.

storage: bool

Should storage be enabled for this pipeline?

• If false (default), the pipeline’s state is kept in in-memory data-structures. This is useful if the pipeline’s state will fit in memory and if the pipeline is ephemeral and does not need to be recovered after a restart. The pipeline will most likely run faster since it does not need to access storage.

• If true, the pipeline’s state is kept on storage. This allows the pipeline to work with state that will not fit into memory. It also allows the state to be checkpointed and recovered across restarts. This feature is currently experimental.

fault_tolerance: Option<FtConfig>

Configures fault tolerance with the specified start up behavior. Fault tolerance is disabled if this is None or if storage is false.

cpu_profiler: bool

Enable CPU profiler.

The default value is true.

tracing: bool

Enable pipeline tracing.

tracing_endpoint_jaeger: String

Jaeger tracing endpoint to send tracing information to.

min_batch_size_records: u64

Minimal input batch size.

The controller delays pushing input records to the circuit until at least min_batch_size_records records have been received (total across all endpoints) or max_buffering_delay_usecs microseconds have passed since at least one input records has been buffered. Defaults to 0.

max_buffering_delay_usecs: u64

Maximal delay in microseconds to wait for min_batch_size_records to get buffered by the controller, defaults to 0.

resources: ResourceConfig

Resource reservations and limits. This is enforced only in Feldera Cloud.

min_storage_bytes: Option<usize>

The minimum estimated number of bytes in a batch of data to write it to storage. This is provided for debugging and fine-tuning and should ordinarily be left unset. It only has an effect when storage is set to true.

A value of 0 will write even empty batches to storage, and nonzero values provide a threshold. usize::MAX would effectively disable storage.

clock_resolution_usecs: Option<u64>

Real-time clock resolution in microseconds.

This parameter controls the execution of queries that use the NOW() function. The output of such queries depends on the real-time clock and can change over time without any external inputs. The pipeline will update the clock value and trigger incremental recomputation at most each clock_resolution_usecs microseconds.

It is set to 100 milliseconds (100,000 microseconds) by default.

Set to null to disable periodic clock updates.

Implementations

impl RuntimeConfig

pub fn from_yaml(s: &str) -> Self

pub fn to_yaml(&self) -> String

Trait Implementations

impl Clone for RuntimeConfig

fn clone(&self) -> RuntimeConfig

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for RuntimeConfig

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

Formats the value using the given formatter.

impl Default for RuntimeConfig

fn default() -> Self

Returns the “default value” for a type.

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

where RuntimeConfig: Default,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for RuntimeConfig

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for RuntimeConfig

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<'__s> ToSchema<'__s> for RuntimeConfig

fn schema() -> (&'__s str, RefOr<Schema>)

Return a tuple of name and schema or reference to a schema that can be referenced by the name or inlined directly to responses, request bodies or parameters.

fn aliases() -> Vec<(&'__s str, Schema)>

Optional set of alias schemas for the ToSchema::schema.

impl Eq for RuntimeConfig

impl StructuralPartialEq for RuntimeConfig