Struct SettingsLogs 

pub struct SettingsLogs {
    pub archive_hook: SettingsLogsArchiveHook,
    pub line_retention: i64,
    pub log_format: String,
    pub time_retention: String,
    pub timestamp: bool,
    pub timestamp_format: String,
}

The logs.* settings.

Fields

archive_hook: SettingsLogsArchiveHook

line_retention: i64

Count-based log retention (e.g. 10000)

Maximum number of log entries to keep per daemon in the SQLite log store.

When set, only the most recent N log entries are retained. Older entries are automatically pruned.

When set to 0 (default), no count-based pruning is performed. You can combine this with time_retention to enforce both a time limit and a line count limit.

Logs are pruned automatically by the supervisor during its interval watcher cycle (no more than once per hour). No manual rotation command is needed.

log_format: String

Default log format for daemons (json | logfmt | text)

time_retention: String

Time-based log retention duration (e.g. ‘7d’, ‘30d’)

Maximum age of log entries to keep in the SQLite log store.

When set, log entries older than this duration are automatically pruned. Examples: "7d" for 7 days, "30d" for 30 days, "1h" for 1 hour.

When empty (default), no time-based pruning is performed. You can combine this with line_retention to enforce both a time limit and a line count limit.

Logs are pruned automatically by the supervisor during its interval watcher cycle (no more than once per hour). No manual rotation command is needed.

timestamp: bool

Show timestamps in log output

When enabled (default), pitchfork prefixes each log line with a timestamp (e.g. 07-10 10:30:00).

When disabled, timestamps are omitted from pitchfork logs output. This is useful when piping logs to tools like lnav that expect raw JSON or when you want to process log output without the timestamp prefix.

Can be overridden per-invocation with pitchfork logs --no-timestamp.

timestamp_format: String

strftime format for log timestamps in pitchfork logs output

Controls the date/time format used when displaying timestamps in pitchfork logs output. Uses chrono strftime syntax.

Common format specifiers:

• %Y — full year (2024)
• %m — month (01-12)
• %d — day (01-31)
• %H — hour (00-23)
• %M — minute (00-59)
• %S — second (00-59)

Examples:

• %m-%d %H:%M:%S — 07-10 10:30:00 (default)
• %Y-%m-%d %H:%M:%S — 2024-07-10 10:30:00
• %H:%M:%S — 10:30:00 (time only)
• %Y/%m/%d %H:%M — 2024/07/10 10:30

Only affects the text display output, not --json or --raw modes.

Implementations

impl SettingsLogs

pub const SETTINGS_PROPS: &'static [PropMeta] = <Self as ::usage_config::Props>::PROPS

Every setting this struct declares, one entry per field, flattened groups included. The registry a build.rs used to generate, generated from the struct instead — there is no second declaration to keep in step.

pub const SETTINGS_REGISTRY: Registry

The registry over Self::SETTINGS_PROPS, for resolve, drift, and the layers.

pub const SETTINGS_SPEC: ConfigSpec

Metadata used only when lowering this declaration into a usage spec.

pub fn read(__usage_resolved: &Resolved) -> Result<Self, ReadErrors>

This resolution’s values, as the struct.

Every field is read before anything is returned, so the error is the whole list of what is wrong rather than the first thing found.

pub fn read_lossy(__usage_resolved: &Resolved) -> (Option<Self>, ReadErrors)

This resolution’s values, keeping every setting that reads.

Self::read is all or nothing, which leaves a CLI two moves when one field is bad: refuse to start, or fall back to a struct of declared defaults and lose the environment and every config file along with the offending value. Neither is a choice this crate should be making.

So: a field that will not read falls back to its own declared default and the rest keep what the merge gave them, with every failure returned alongside for the CLI to raise, log, or ignore as it sees fit. The errors are the same ::usage_config::ReadErrors Self::read returns, so a caller that decides a bad value is fatal has lost nothing by asking.

None only where a setting has no value and no declared default — a hole in the declaration rather than a bad value, and nothing to fall back to.

pub fn spec_kdl() -> String

The spec config block for these settings, as KDL.

What documents, JSON schema and completions read. A CLI deriving usage::Cli names this type in #[usage(config = ...)] instead of calling this, and its to_kdl carries the block.

Trait Implementations

impl Clone for SettingsLogs

fn clone(&self) -> SettingsLogs

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SettingsLogs

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

Formats the value using the given formatter.

impl PartialEq for SettingsLogs

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

Equality operator ==.

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

Inequality operator !=.

impl Props for SettingsLogs

const PROPS: &'static [PropMeta]

This group’s settings, in declaration order.

const PROP_SPECS: &'static [PropSpec]

Spec-only metadata parallel to Props::PROPS.

impl StructuralPartialEq for SettingsLogs