Configuration

LesliAudit reads its settings from Lesli.config.audit. Override only the values that differ from the defaults and merge them with the existing hash so future engine defaults are preserved:

# config/initializers/lesli.rb
Lesli.configure do |config|
  config.audit = config.audit.merge(
    enable_logs: true,
    enable_journals: true,
    enable_analytics: true,
    journal_retention_days: 90,
    analytics_retention_days: 400,
    audit_retention_days: nil
  )
end

Settings

Setting	Type	Default	Behavior
`enable_logs`	Boolean	`true`	Enables explicit account and user activity events
`enable_journals`	Boolean	`true`	Records individual requests as user journal history
`enable_analytics`	Boolean	`true`	Builds account/user request aggregates and successful-login device aggregates
`journal_retention_days`	Positive integer or `nil`	`90`	Retention period for processed, retained journals
`analytics_retention_days`	Positive integer or `nil`	`400`	Retention period for aggregate analytics and transient journals
`audit_retention_days`	Positive integer or `nil`	`nil`	Retention period for append-only activity events

nil disables automatic cleanup for that data class. Invalid retention values raise ArgumentError when cleanup runs. Keep audit_retention_days unset until the host application has defined its legal-hold, export, and deletion policy.

Analytics and Journal Modes

The analytics and journal switches are independent:

Analytics	Journals	Result
Enabled	Enabled	Update request aggregates and record the individual request journal
Enabled	Disabled	Update request aggregates without creating a journal
Disabled	Enabled	Record the individual request journal without updating aggregate counters
Disabled	Disabled	Do not capture a request event

Explicit activity events are controlled only by enable_logs; the analytics switches do not affect them.

Retention Cleanup Job

Schedule LesliAudit::RetentionCleanupJob once per day after choosing retention periods. LesliAudit intentionally does not select a scheduler or queue because those are host-application concerns. See Tasks for the equivalent manual cleanup command.

Optional Engines

LesliShield is optional. When installed, its session identifier is recorded as opaque metadata; LesliAudit does not create a foreign key to Shield tables.

LesliDashboard is also optional. Its installation does not change audit capture or retention. See Dashboards when enabling the Audit dashboard component.

Edit this page

Last Update: 2026/10/19