batcher

package

v1.10.0 Latest Latest Go to latest Published: Nov 3, 2026 License: MIT Imports: 5 Imported by: 0

Details

Package batcher provides batched event writing for Chronicle. Events are accumulated and flushed on size threshold, time interval, or shutdown.

This section is empty.

This section is empty.

This section is empty.

type Batcher struct {
	// contains filtered or unexported fields
}

Batcher accumulates events and flushes them in batches.

func New(batchSize int, flushInterval time.Duration, flushFn FlushFunc, logger log.Logger) *Batcher

New creates a new Batcher.

func (b *Batcher) Add(ctx context.Context, event *audit.Event) error

Add adds an event to the batch buffer. If the batch is full, it flushes immediately.

A failed flush leaves the events buffered so a later flush can retry, rather than dropping audit records because the store was briefly unavailable.

func (b *Batcher) Flush(ctx context.Context) error

Flush writes any buffered events. The buffer is only cleared once flushFn succeeds, so a failure can be retried without losing the batch.

func (b *Batcher) Pending() int

Pending reports how many events are buffered.

func (b *Batcher) Start()

Start begins the background flush ticker.

func (b *Batcher) Stop(ctx context.Context) error

Stop signals the batcher to stop and flushes remaining events.

Safe to call more than once: a caller that both defers Stop and calls it on the shutdown path used to panic here, because stopCh was closed twice.

type FlushFunc func(ctx context.Context, events []*audit.Event) error

FlushFunc is called when a batch of events is ready to be persisted.