Struct EventsConfig 

#[non_exhaustive]
pub struct EventsConfig {
    pub filter: Option<String>,
    pub sampling: SamplingConfig,
    pub limits: LimitsConfig,
    pub audit: AuditConfig,
    pub queues: QueuesConfig,
    pub sinks: SinksConfig,
    pub service: ServiceConfig,
    pub dev_mode: bool,
}

The complete config tree. Every field is optional so a config file can be a single line if the user only cares to override filter.

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.

filter: Option<String>

EnvFilter-grammar directives. None ⇒ defer to OBS_FILTER env var; if both unset, "info" applies.

sampling: SamplingConfig

Head/tail sampling tunables.

limits: LimitsConfig

Per-event byte caps.

audit: AuditConfig

AUDIT-tier delivery policy (Phase 3 task 3.12 implements the spool; the config struct lives here so user obs.yaml files already have a stable shape).

queues: QueuesConfig

Per-tier mpsc queue capacities (Phase 3 worker pool).

sinks: SinksConfig

Per-sink configuration (Phase 3+ implements the sinks; the config struct lives here so user obs.yaml files already have a stable shape).

service: ServiceConfig

Service identity (overrides defaults read from env).

dev_mode: bool

Dev-mode toggle (OBS_DEV=1 or dev_mode: true). Enables extra diagnostics intended for local iteration: more verbose scope-field warnings, source-loc capture, and the dev_ergonomics test path. Spec 13 § 2.3 / 60 § 7 / spec 94 § 3.10 / P3-A.

Implementations

impl EventsConfig

pub fn builder() -> EventsConfigBuilder

Builder entry. See spec 15 § 5.1.

pub fn from_yaml_str(yaml: &str) -> Result<EventsConfig, ConfigError>

Parse YAML bytes into an EventsConfig. Spec 15 § 5.1 / spec 93 P0-9. ${VAR} references in scalar string values are expanded against the process environment before parsing — set ${VAR:-default} to provide a fallback.

Unknown top-level keys fail parsing (struct is deny_unknown_fields). The error message is annotated with the valid root-key set so typos like filtr: surface with an immediate fix-up hint — boundary-review § 4.1.

Errors

Returns ConfigError::Yaml when parsing fails (unknown fields, type mismatch, syntax error). Validation is left to the caller — call Self::validate after loading.

pub fn from_yaml_path( path: impl AsRef<Path>, ) -> Result<EventsConfig, ConfigError>

Read a YAML file from disk.

Errors

Returns ConfigError::Io when the file cannot be read or ConfigError::Yaml when parsing fails.

pub fn merged_with_env(self, prefix: &str) -> EventsConfig

Apply environment-variable overrides under prefix. The convention is <PREFIX>_<DOTTED_PATH_WITH___INSTEAD_OF_DOTS> — e.g. OBS_FILTER for filter, OBS_AUDIT__SPOOL_DIR for audit.spool_dir, OBS_SAMPLING__DEFAULT_RATE for sampling.default_rate. Values are parsed by re-running serde_yaml against the resulting flat map. Spec 15 § 5.1 / spec 93 P0-9.

impl EventsConfig

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

Validate ranges. Returns the first violation found, or Ok if the config is well-formed. Spec 15 § 6.

Errors

Returns a ConfigError describing the first invalid setting.

Trait Implementations

impl Clone for EventsConfig

fn clone(&self) -> EventsConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for EventsConfig

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

Formats the value using the given formatter.

impl Default for EventsConfig

fn default() -> EventsConfig

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for EventsConfig

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for EventsConfig

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

where __S: Serializer,

Serialize this value into the given Serde serializer.