Skip to main content

AuditSystem

rustfs_audit::system

Struct AuditSystem 

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

Main audit system that manages target lifecycle and audit log dispatch

Implementations§

Source§

impl AuditSystem

Source

pub fn new() -> Self

Creates a new audit system

Source

pub async fn start(&self, config: Config) -> AuditResult<()>

Starts the audit system with the given configuration

§Arguments
  • config - The configuration to use for starting the audit system
§Returns
  • AuditResult<()> - Result indicating success or failure
Source

pub async fn pause(&self) -> AuditResult<()>

Pauses the audit system

§Returns
  • AuditResult<()> - Result indicating success or failure
Source

pub async fn resume(&self) -> AuditResult<()>

Resumes the audit system

§Returns
  • AuditResult<()> - Result indicating success or failure
Source

pub async fn close(&self) -> AuditResult<()>

Stops the audit system and closes all targets

§Returns
  • AuditResult<()> - Result indicating success or failure
Source

pub async fn get_state(&self) -> AuditSystemState

Gets the current state of the audit system

Source

pub async fn is_running(&self) -> bool

Checks if the audit system is running

§Returns
  • bool - True if running, false otherwise
Source

pub async fn dispatch(&self, entry: Arc<AuditEntry>) -> AuditResult<()>

Dispatches an audit log entry to all active targets

§Arguments
  • entry - The audit log entry to dispatch
§Returns
  • AuditResult<()> - Result indicating success or failure
Source

pub async fn dispatch_batch( &self, entries: Vec<Arc<AuditEntry>>, ) -> AuditResult<()>

Dispatches a batch of audit log entries to all active targets

§Arguments
  • entries - A vector of audit log entries to dispatch
§Returns
  • AuditResult<()> - Result indicating success or failure
Source

pub async fn enable_target(&self, target_id: &str) -> AuditResult<()>

Enables a specific target

§Arguments
  • target_id - The ID of the target to enable, TargetID to string
§Returns
  • AuditResult<()> - Result indicating success or failure
Source

pub async fn disable_target(&self, target_id: &str) -> AuditResult<()>

Disables a specific target

§Arguments
  • target_id - The ID of the target to disable, TargetID to string
§Returns
  • AuditResult<()> - Result indicating success or failure
Source

pub async fn remove_target(&self, target_id: &str) -> AuditResult<()>

Removes a target from the system

§Arguments
  • target_id - The ID of the target to remove, TargetID to string
§Returns
  • AuditResult<()> - Result indicating success or failure
Source

pub async fn upsert_target( &self, target_id: String, target: Box<dyn Target<AuditEntry> + Send + Sync>, ) -> AuditResult<()>

Updates or inserts a target

§Arguments
  • target_id - The ID of the target to upsert, TargetID to string
  • target - The target instance to insert or update
§Returns
  • AuditResult<()> - Result indicating success or failure
Source

pub async fn list_targets(&self) -> Vec<String>

Lists all targets

§Returns
  • Vec<String> - List of target IDs
Source

pub async fn get_target_values(&self) -> Vec<SharedTarget<AuditEntry>> ⓘ

Returns cloned target values for read-only runtime inspection.

Source

pub async fn snapshot_target_metrics(&self) -> Vec<AuditTargetMetricSnapshot>

Returns per-target delivery metrics for Prometheus collection.

Source

pub async fn snapshot_target_health(&self) -> Vec<RuntimeTargetHealthSnapshot>

Source

pub async fn runtime_status_snapshot(&self) -> RuntimeStatusSnapshot

Source

pub async fn get_target(&self, target_id: &str) -> Option<String>

Gets information about a specific target

§Arguments
  • target_id - The ID of the target to retrieve, TargetID to string
§Returns
  • Option<String> - Target ID if found
Source

pub async fn reload_config(&self, new_config: Config) -> AuditResult<()>

Reloads configuration and updates targets

§Arguments
  • new_config - The new configuration to load
§Returns
  • AuditResult<()> - Result indicating success or failure
Source

pub async fn get_metrics(&self) -> AuditMetricsReport

Gets current audit system metrics

§Returns
  • AuditMetricsReport - Current metrics report
Source

pub async fn validate_performance(&self) -> PerformanceValidation

Validates system performance against requirements

§Returns
  • PerformanceValidation - Performance validation results
Source

pub async fn reset_metrics(&self)

Resets all metrics to initial state

Trait Implementations§

Source§

impl Clone for AuditSystem

Source§

fn clone(&self) -> AuditSystem

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Default for AuditSystem

Source§

fn default() -> Self

Returns the “default value” for a type. 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<'a, T, E> AsTaggedExplicit<'a, E> for T
where T: 'a,

Source§

fn explicit(self, class: Class, tag: u32) -> TaggedParser<'a, Explicit, Self, E>

Source§

impl<'a, T, E> AsTaggedImplicit<'a, E> for T
where T: 'a,

Source§

fn implicit( self, class: Class, constructed: bool, tag: u32, ) -> TaggedParser<'a, Implicit, Self, E>

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<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> CompatExt for T

Source§

fn compat(self) -> Compat<T> ⓘ
where T: Sized,

Applies the Compat adapter by value. Read more
Source§

fn compat_ref(&self) -> Compat<&T> ⓘ

Applies the Compat adapter by shared reference. Read more
Source§

fn compat_mut(&mut self) -> Compat<&mut T> ⓘ

Applies the Compat adapter by mutable reference. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> FromExt for T

Source§

fn from_<T>(t: T) -> Self
where Self: From<T>,

Source§

impl<T> FromRef<T> for T
where T: Clone,

Source§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
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> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self> ⓘ

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self> ⓘ
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> IntoExt for T

Source§

fn into_<T>(self) -> T
where Self: Into<T>,

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

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

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

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
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> TryFromExt for T

Source§

fn try_from_<T>(t: T) -> Result<Self, Self::Error>
where Self: TryFrom<T>,

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

Source§

fn try_into_<T>(self) -> Result<T, Self::Error>
where Self: TryInto<T>,

Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

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