bundleevents

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

type Notifier interface {
	// ObserveBundle reports failures and recoveries of a bundle's
	// deployments. Old is the bundle as previously persisted, which makes
	// the state change survive a restart of the controller.
	ObserveBundle(ctx context.Context, old, cur *fleet.Bundle)

	// ObserveBundleDeployment reports a single bundle deployment, if
	// per-deployment reporting is enabled. Old is the bundle deployment as
	// previously persisted, which makes the state change survive a restart
	// of the controller.
	ObserveBundleDeployment(ctx context.Context, old, cur *fleet.BundleDeployment)

	// Forget drops everything remembered about an object. Callers report
	// objects which are going away, so that nothing is kept for them.
	Forget(uid types.UID)
}

type Option func(*Emitter)

type Options struct {
	// Enabled turns event reporting on or off.
	Enabled bool

	// Debounce is how long to wait for a burst of failures to settle before
	// reporting it, so that the reported counts and causes describe the
	// whole burst instead of only its first failure.
	Debounce time.Duration

	// MinInterval is the minimum time between two events for the same
	// object. It bounds how often a flapping deployment reports.
	MinInterval time.Duration

	// ReportRecovery reports bundles whose deployments all became ready
	// again after a failure.
	ReportRecovery bool

	// PerDeployment additionally reports each failing bundle deployment.
	// This is more detailed, but produces one event per failing deployment,
	// in the namespace of its cluster.
	PerDeployment bool

	// MaxCauses is how many distinct failure causes a single event describes.
	MaxCauses int

	// MaxTracked is the number of objects the emitter remembers in order to
	// deduplicate their events.
	MaxTracked int
}