Expand description
RustFS Notify - A flexible and extensible event notification system for object storage.
This library provides a Rust implementation of a storage bucket notification system. It supports sending events to various targets (like Webhook and MQTT) and includes features like event persistence and retry on failure.
Re-exports§
pub use integration::NotificationMetricSnapshot;pub use integration::NotificationSystem;pub use integration::NotificationTargetMetricSnapshot;pub use rules::BucketNotificationConfig;
Modules§
- factory
- integration
- notifier
- notifier_
global - A module providing the public API for event notification.
- registry
- rules
Structs§
- Event
- Represents a storage event
- Event
Args - Event
Args Builder - Builder for
EventArgs. - Live
Event History - Notification
Lifecycle Transition - Notify
Bucket Config Manager - Notify
Config Manager - Notify
Object Info - Object metadata required by notification event serialization.
- Notify
Pipeline - Notify
Rule Engine - Notify
Runtime Facade - Notify
Runtime View - Notify
Services - Notify
Status View - Notify
Store
Enums§
- Lifecycle
Error - Errors related to the notification system’s lifecycle.
- Notification
Error - Error types for the notification system
- Notification
Runtime State
Functions§
- ensure_
live_ events - Ensures the stable process-wide live-event container exists.
- initialize
- Initialize the global notification system with the given configuration.
- initialize_
live_ events - Initialize the global notification system only for live in-process consumers.
- is_
notification_ system_ initialized - Check if the notification system has been initialized.
- notification_
metrics_ snapshot - Returns aggregate notification delivery metrics for Prometheus collection.
- notification_
system - Returns a handle to the global NotificationSystem instance. Return None if the system has not been initialized.
- notification_
target_ metrics - Returns per-target notification delivery metrics for Prometheus collection.
- reconcile
- Ensures the stable singleton exists and reconciles its target runtime.
- runtime_
target_ id_ for_ subsystem