Struct ObservabilityConfig 

pub struct ObservabilityConfig {
    pub tool_name: ToolName,
    pub log_root: PathBuf,
    pub env_prefix: EnvPrefix,
    pub queue_capacity: usize,
    pub retained_log_policy: RetainedLogPolicy,
}

Top-level configuration for the observation routing runtime.

Routing owns tool identity, log-root selection, env-prefix derivation, and queue capacity. Logging-specific level, retention, and redaction behavior stay owned by LoggerConfig in sc-observability and are intentionally not overridable at the ObservabilityConfig layer.

Fields

tool_name: ToolName

Stable tool name used to derive service and log layout defaults.

log_root: PathBuf

Root directory that owns the routing runtime log tree.

env_prefix: EnvPrefix

Environment-variable prefix used by the owning application.

queue_capacity: usize

Reserved for future async/backpressure implementation. Phase 1 execution is synchronous; this value is stored but not yet applied.

retained_log_policy: RetainedLogPolicy

Retained-log policy forwarded to the built-in logging layer.

Implementations

impl ObservabilityConfig

pub fn default_for( tool_name: ToolName, log_root: PathBuf, ) -> Result<Self, InitError>

Builds the documented v1 defaults from a tool name and log root.

Examples

use std::path::PathBuf;
use sc_observability_types::ToolName;
use sc_observe::ObservabilityConfig;

let config = ObservabilityConfig::default_for(
    ToolName::new("demo-tool").expect("valid tool"),
    PathBuf::from("logs"),
)
.expect("valid config");

assert_eq!(config.tool_name.as_str(), "demo-tool");

pub fn service_name(&self) -> Result<ServiceName, InitError>

Derives the logging/telemetry service name from the configured tool.

Trait Implementations

impl Clone for ObservabilityConfig

fn clone(&self) -> ObservabilityConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ObservabilityConfig

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

Formats the value using the given formatter.