Skip to main content

AuditLog

Struct AuditLog 

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

An append-only, bounded audit log for coordinator state changes.

Thread-safety note: this struct is not internally synchronised. In a multi-threaded context, wrap it in Arc<Mutex<AuditLog>> or similar.

Implementations§

Source§

impl AuditLog

Source

pub fn new(config: AuditLogConfig) -> Self

Create a new audit log with the given configuration.

Source

pub fn with_defaults() -> Self

Create a new audit log with default configuration.

Source

pub fn append(&mut self, builder: AuditEntryBuilder) -> Option<u64>

Append an entry built from a builder.

Returns the assigned sequence number, or None if the event was filtered out by the minimum severity setting.

Source

pub fn log_job_submitted( &mut self, job_id: Uuid, actor: &str, codec: &str, ) -> Option<u64>

Convenience: log a job submission.

Source

pub fn log_job_cancelled( &mut self, job_id: Uuid, actor: &str, reason: &str, ) -> Option<u64>

Convenience: log a job cancellation.

Source

pub fn log_job_failed( &mut self, job_id: Uuid, actor: &str, error: &str, ) -> Option<u64>

Convenience: log a job failure.

Source

pub fn log_worker_joined(&mut self, worker_id: &str, addr: &str) -> Option<u64>

Convenience: log a worker joining the cluster.

Source

pub fn log_worker_left(&mut self, worker_id: &str, reason: &str) -> Option<u64>

Convenience: log a worker leaving the cluster.

Source

pub fn log_leader_elected(&mut self, leader_id: &str, term: u64) -> Option<u64>

Convenience: log a leader election.

Source

pub fn len(&self) -> usize

Number of entries currently in the log.

Source

pub fn is_empty(&self) -> bool

Whether the log is empty.

Source

pub fn total_appended(&self) -> u64

Total entries ever appended (including evicted).

Source

pub fn get_by_sequence(&self, seq: u64) -> Option<&AuditEntry>

Get an entry by sequence number.

Source

pub fn recent(&self, n: usize) -> Vec<&AuditEntry>

Return the most recent n entries (newest last).

Source

pub fn query_by_kind(&self, kind: AuditEventKind) -> Vec<&AuditEntry>

Query entries by event kind.

Source

pub fn query_by_actor(&self, actor: &str) -> Vec<&AuditEntry>

Query entries by actor.

Source

pub fn query_by_target(&self, target: &str) -> Vec<&AuditEntry>

Query entries by target.

Source

pub fn query_by_min_severity(&self, min: AuditSeverity) -> Vec<&AuditEntry>

Query entries by severity at or above the given level.

Source

pub fn query_by_time_range( &self, start_us: u64, end_us: u64, ) -> Vec<&AuditEntry>

Query entries within a time range (microseconds since Unix epoch).

Source

pub fn clear(&mut self)

Clear all entries.

Source

pub fn export_all(&self) -> Vec<AuditEntry>

Export all entries as a vector (for serialization or transfer).

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> IntoRequest<T> for T

Source§

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request
Source§

impl<L> LayerExt<L> for L

Source§

fn named_layer<S>(&self, service: S) -> Layered<<L as Layer<S>>::Service, S>
where L: Layer<S>,

Applies the layer to a service and wraps it in Layered.
Source§

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

Source§

type Error = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

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