filter

Documentation

Index

• func Filter(h heartbeat.Heartbeat, config Config) error
• func WithFiltering(config Config) heartbeat.HandleOption
• type Config
• type Err
  • func (e Err) Error() string

Functions

func Filter

func Filter(h heartbeat.Heartbeat, config Config) error

Filter determines, following the passed in configurations, if a heartbeat should be skipped. Returns Err to signal to the caller to skip the heartbeat.

func WithFiltering

func WithFiltering(config Config) heartbeat.HandleOption

WithFiltering initializes and returns a heartbeat handle option, which can be used in a heartbeat processing pipeline to filter heartbeats following the provided configurations.

Types

type Config

type Config struct {
	Exclude                    []regex.Regex
	ExcludeUnknownProject      bool
	Include                    []regex.Regex
	IncludeOnlyWithProjectFile bool
}

Config contains filtering configurations.

type Err

type Err string

Err is a heartbeat filtering error, signaling to skip the heartbeat.

func (Err) Error

func (e Err) Error() string

Error implements error interface.