Struct SummaryEmitter 

pub struct SummaryEmitter<S>
where
    S: Storage<EventSignature, EventState> + Clone,
{ /* private fields */ }

Emits periodic summaries of suppressed events.

Implementations

impl<S> SummaryEmitter<S>

where S: Storage<EventSignature, EventState> + Clone,

pub fn new(registry: SuppressionRegistry<S>, config: EmitterConfig) -> Self

Create a new summary emitter.

pub fn collect_summaries(&self) -> Vec<SuppressionSummary>

Collect current suppression summaries.

Returns summaries for all events that have been suppressed at least min_count times.

pub fn start<F>(self, emit_fn: F, emit_final: bool) -> EmitterHandle

where F: FnMut(Vec<SuppressionSummary>) + Send + 'static, S: Send + 'static,

Start emitting summaries periodically (async version).

This spawns a background task that emits summaries at the configured interval. The task will run until shutdown() is called on the returned EmitterHandle.

Graceful Shutdown

When shutdown() is called on the EmitterHandle:

1. The shutdown signal is prioritized over tick events
2. The current emission completes if in progress
3. If emit_final is true, one final emission occurs with current summaries
4. The background task completes gracefully

Cancellation Safety

The spawned task is cancellation-safe:

• collect_summaries() reads atomically from storage without mutations
• If cancelled during emission, the next startup will see correct state
• Panics in emit_fn are caught and don’t abort the task
• The emit_fn closure should be cancellation-safe (avoid holding locks across .await)

Type Parameters

• F - The emission function. Must be Send + 'static because it runs in a spawned task that may execute on any thread in the tokio runtime. The function receives ownership of the summaries vector.

Examples

let emitter = SummaryEmitter::new(registry, config);
let handle = emitter.start(|summaries| {
    for summary in summaries {
        tracing::warn!("{}", summary.format_message());
    }
}, true);

// Later, trigger graceful shutdown
handle.shutdown().await.expect("shutdown failed");

pub fn config(&self) -> &EmitterConfig

Get the emitter configuration.

pub fn registry(&self) -> &SuppressionRegistry<S>

Get a reference to the registry.