Documentation ¶
Overview ¶
Package nflog implements a garbage-collected and snapshottable append-only log of active/resolved notifications. Each log entry stores the active/resolved state, the notified receiver, and a hash digest of the notification's identifying contents. The log can be queried along different parameters.
Index ¶
- Variables
- type Log
- func (l *Log) GC() (int, error)
- func (l *Log) Log(r *pb.Receiver, gkey string, firingAlerts, resolvedAlerts []uint64) error
- func (l *Log) MarshalBinary() ([]byte, error)
- func (l *Log) Merge(b []byte) error
- func (l *Log) Query(params ...QueryParam) ([]*pb.Entry, error)
- func (l *Log) SetBroadcast(f func([]byte))
- func (l *Log) Snapshot(w io.Writer) (int64, error)
- type Option
- type QueryParam
Constants ¶
This section is empty.
Variables ¶
var ErrNotFound = errors.New("not found")
ErrNotFound is returned for empty query results.
Functions ¶
This section is empty.
Types ¶
type Log ¶
type Log struct {
// contains filtered or unexported fields
}
func New ¶
New creates a new notification log based on the provided options. The snapshot is loaded into the Log if it is set.
func (*Log) MarshalBinary ¶ added in v0.15.0
MarshalBinary serializes all contents of the notification log.
func (*Log) Merge ¶ added in v0.15.0
Merge merges notification log state received from the cluster with the local state.
func (*Log) Query ¶
func (l *Log) Query(params ...QueryParam) ([]*pb.Entry, error)
Query implements the Log interface.
func (*Log) SetBroadcast ¶ added in v0.15.0
SetBroadcast sets a broadcast callback that will be invoked with serialized state on updates.
type Option ¶
Option configures a new Log implementation.
func WithLogger ¶
WithLogger configures a logger for the notification log.
func WithMaintenance ¶
WithMaintenance configures the Log to run garbage collection and snapshotting, if configured, at the given interval.
The maintenance terminates on receiving from the provided channel. The done function is called after the final snapshot was completed.
func WithMetrics ¶ added in v0.5.1
func WithMetrics(r prometheus.Registerer) Option
WithMetrics registers metrics for the notification log.
func WithNow ¶
WithNow overwrites the function used to retrieve a timestamp for the current point in time. This is generally useful for injection during tests.
func WithRetention ¶
WithRetention sets the retention time for log st.
func WithSnapshot ¶
WithSnapshot configures the log to be initialized from a given snapshot file. If maintenance is configured, a snapshot will be saved periodically and on shutdown as well.
type QueryParam ¶
type QueryParam func(*query) error
QueryParam is a function that modifies a query to incorporate a set of parameters. Returns an error for invalid or conflicting parameters.
func QGroupKey ¶
func QGroupKey(gk string) QueryParam
QGroupKey adds a group key as querying argument.
func QReceiver ¶
func QReceiver(r *pb.Receiver) QueryParam
QReceiver adds a receiver parameter to a query.