Struct LogPolicy 

pub struct LogPolicy {
    pub full_paths: bool,
    pub sensitivity: Sensitivity,
    pub paths: PathAliases,
    /* private fields */
}

Filters events before formatting and sanitizes values before ordinary sinks.

Fields

full_paths: bool

Enables full typed-path output only by explicit configuration.

sensitivity: Sensitivity

Safe, Diagnostic or explicit encrypted Sensitive output.

paths: PathAliases

Trusted aliases for typed local path fields.

Implementations

impl LogPolicy

pub fn new(verbosity: Verbosity) -> Self

Creates a safe policy with one global verbosity threshold.

Examples found in repository

examples/verbosity.rs (line 20)

fn main() {
    // V4 remains the default for application-wide operational messages.
    let mut policy = LogPolicy::new(Verbosity::V4);

    // Only synchronization is allowed to emit V5 through V9 details.
    policy.set_component("sync", Verbosity::V9);
}

examples/component_filter.rs (line 21)

fn main() {
    // All components start at V4, keeping normal output concise.
    let mut policy = LogPolicy::new(Verbosity::V4);

    // Synchronization may need temporary I/O and timing diagnostics.
    policy.set_component("sync", Verbosity::V8);

    let log = LogDispatcher::new(policy, vec![Arc::new(ConsoleSink::new())]);

    let event = log.event(0, "sync");

    // This V7 event is selected only because the sync override allows it.
    event.verbosity(7).debug("batch details");
}

examples/file_logging.rs (line 32)

fn main() -> Result<(), appcore_log::LogConfigError> {
    // Keep generated output predictable and inside Cargo's ignored target tree.
    let output_directory = PathBuf::from("target/appcore-log-example");
    std::fs::create_dir_all(&output_directory).map_err(|_| LogConfigError::Sink(LogError::Io))?;

    let active_file = output_directory.join("application.jsonl");

    // Two rotations stay beside the active file. Older rotations move into
    // archive/YYYY/MM and the complete archive never exceeds 120 files.
    let archive_directory = output_directory.join("archive");
    let mut policy = LogPolicy::new(Verbosity::V4);
    policy.set_component("sync", Verbosity::V8);

    let logger = LoggerConfig {
        policy,
        output: LogOutputMode::TerminalAndFile,
        file: Some(FileSinkConfig {
            path: active_file,
            max_bytes: LOG_SIZE_8_MIB,
            sync_each_write: false,
            retention: 2,
            archive: Some(FileArchiveConfig {
                directory: archive_directory,
                max_files: 120,
            }),
        }),
        ..LoggerConfig::default()
    }
    .build()?;

    let application = logger.dispatcher().event(0, "application");
    let sync = logger.dispatcher().event(1, "sync.transport");

    application.info("application ready; inspect target/appcore-log-example/application.jsonl");

    // The parent component policy makes this V7 diagnostic visible.
    sync.verbosity(7).debug("replication batch sent");

    sync.warn("peer response was delayed");

    let stats = logger.dispatcher().stats();
    assert_eq!(stats.sink_failures, 0);

    Ok(())
}

pub fn set_component( &mut self, component: impl Into<String>, verbosity: Verbosity, )

Overrides a component threshold without changing the global threshold.

Examples found in repository

examples/verbosity.rs (line 23)

fn main() {
    // V4 remains the default for application-wide operational messages.
    let mut policy = LogPolicy::new(Verbosity::V4);

    // Only synchronization is allowed to emit V5 through V9 details.
    policy.set_component("sync", Verbosity::V9);
}

examples/component_filter.rs (line 24)

fn main() {
    // All components start at V4, keeping normal output concise.
    let mut policy = LogPolicy::new(Verbosity::V4);

    // Synchronization may need temporary I/O and timing diagnostics.
    policy.set_component("sync", Verbosity::V8);

    let log = LogDispatcher::new(policy, vec![Arc::new(ConsoleSink::new())]);

    let event = log.event(0, "sync");

    // This V7 event is selected only because the sync override allows it.
    event.verbosity(7).debug("batch details");
}

examples/file_logging.rs (line 33)

fn main() -> Result<(), appcore_log::LogConfigError> {
    // Keep generated output predictable and inside Cargo's ignored target tree.
    let output_directory = PathBuf::from("target/appcore-log-example");
    std::fs::create_dir_all(&output_directory).map_err(|_| LogConfigError::Sink(LogError::Io))?;

    let active_file = output_directory.join("application.jsonl");

    // Two rotations stay beside the active file. Older rotations move into
    // archive/YYYY/MM and the complete archive never exceeds 120 files.
    let archive_directory = output_directory.join("archive");
    let mut policy = LogPolicy::new(Verbosity::V4);
    policy.set_component("sync", Verbosity::V8);

    let logger = LoggerConfig {
        policy,
        output: LogOutputMode::TerminalAndFile,
        file: Some(FileSinkConfig {
            path: active_file,
            max_bytes: LOG_SIZE_8_MIB,
            sync_each_write: false,
            retention: 2,
            archive: Some(FileArchiveConfig {
                directory: archive_directory,
                max_files: 120,
            }),
        }),
        ..LoggerConfig::default()
    }
    .build()?;

    let application = logger.dispatcher().event(0, "application");
    let sync = logger.dispatcher().event(1, "sync.transport");

    application.info("application ready; inspect target/appcore-log-example/application.jsonl");

    // The parent component policy makes this V7 diagnostic visible.
    sync.verbosity(7).debug("replication batch sent");

    sync.warn("peer response was delayed");

    let stats = logger.dispatcher().stats();
    assert_eq!(stats.sink_failures, 0);

    Ok(())
}

pub fn allows(&self, event: &LogEvent) -> bool

Reports whether an event is selected before serialization or sink I/O.

pub fn sanitize(&self, event: &LogEvent) -> LogEvent

Produces the event accepted by its configured sensitivity boundary.

In Safe and Diagnostic modes all normal sinks receive redacted secrets and aliased typed paths. Sensitive mode is routed only to DNT sinks by the dispatcher; fields marked with LogEvent::secret remain redacted even there because they represent prohibited credential material.

Examples found in repository

examples/safe_paths.rs (line 28)

fn main() {
    let mut policy = LogPolicy::default();

    // The deployment provides trusted aliases instead of exposing host paths.
    policy.paths.app_root = Some("/application".to_string());

    let event = LogEvent::new(0, Severity::Info, Verbosity::V4, "storage", "opened")
        .path("file", "/application/data/log.jsonl");

    // Ordinary sinks receive `<APP_ROOT>/data/log.jsonl`, never the raw path.
    let _safe = policy.sanitize(&event);
}

pub fn sanitize_owned(&self, value: LogEvent) -> LogEvent

Sanitizes an owned event without cloning its message or metadata.

pub const fn sensitive_warning() -> &'static str

Returns the warning an application must surface when it enables encrypted sensitive diagnostics.

Trait Implementations

impl Clone for LogPolicy

fn clone(&self) -> LogPolicy

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for LogPolicy

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

Formats the value using the given formatter.

impl Default for LogPolicy

fn default() -> Self

Returns the “default value” for a type.