Struct base::periodic_logger::PeriodicLogger

pub struct PeriodicLogger {
    name: String,
    interval: Duration,
    counters: Arc<RwLock<HashMap<String, AtomicU32>>>,
    worker_thread: Option<WorkerThread<Result<(), PeriodicLoggerError>>>,
}

Utility class that helps count and log high frequency events periodically.

Fields

name: String

interval: Duration

counters: Arc<RwLock<HashMap<String, AtomicU32>>>

worker_thread: Option<WorkerThread<Result<(), PeriodicLoggerError>>>

Implementations

impl PeriodicLogger

pub fn new(name: String, interval: Duration) -> Self

pub fn add_counter_item(&self, name: String) -> Result<(), PeriodicLoggerError>

Add a new event item to be counted.

pub fn increment_counter( &self, name: String, amount: u32 ) -> Result<(), PeriodicLoggerError>

Increment event counter by an amount

pub fn start_logging_thread(&mut self) -> Result<(), PeriodicLoggerError>

Starts a thread that will log the count of events within a self.interval time period. All counters will be reset to 0 after logging.