Skip to main content

FileBackend

Struct FileBackend 

Source
pub struct FileBackend { /* private fields */ }
Expand description

Appends audit events to a file as JSON lines.

§Examples

use ash_log::*;
use std::sync::Arc;

let backend = FileBackend::builder("/var/log/audit.jsonl")
    .rotation(RotationPolicy::size(64 * 1024 * 1024).keeping(10))
    .errors(Arc::new(StderrErrorSink))
    .build()
    .expect("open the audit log");

let logger = Logger::builder(Arc::new(backend)).build();
logger.info("started");

Implementations§

Source§

impl FileBackend

Source

pub fn builder<P: Into<PathBuf>>(path: P) -> FileBackendBuilder

Start building a backend writing to path.

Source

pub fn new<P: Into<PathBuf>>(path: P) -> Result<Self>

Open path for appending with no rotation and no error reporting.

§Errors

Returns the underlying error if the file cannot be opened or created.

Source

pub fn path(&self) -> &Path

The path being written to.

Source

pub fn reopen(&self) -> Result<()>

Close and reopen the file at its original path.

Call this from a SIGHUP handler when an external rotator such as logrotate moves the file aside. Without it the process keeps writing to the renamed inode.

§Errors

Returns the underlying error if the path cannot be reopened. The old handle is dropped either way, so a failure leaves the backend unable to write rather than writing to the wrong place.

Source

pub fn current_size(&self) -> u64

Number of bytes written to the current file.

Source

pub fn rotate(&self) -> Result<()>

Rotate now, regardless of policy.

§Errors

Returns the underlying error if the rename or reopen fails.

Trait Implementations§

Source§

impl AuditBackend for FileBackend

Source§

fn log_audit(&self, event: &AuditEvent)

Write an audit event
Source§

fn security_log(&self, event: &Value)

Write a raw OCSF (or other JSON) security event as a JSON line. Read more
Source§

fn flush(&self)

Flush buffered entries
Source§

impl Debug for FileBackend

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more