dpfilters

Documentation

Overview

Package dpfilters has logic describing the filtering of unwanted metrics. Filters are configured from the agent configuration file and is intended to be passed into each monitor for use if it sends datapoints on its own.

Index

• type DatapointFilter
  • func New(monitorType string, metricNames []string, dimensions map[string]string, ...) (DatapointFilter, error)
• type FilterSet
  • func (fs *FilterSet) Matches(dp *datapoint.Datapoint) bool

Types

type DatapointFilter

type DatapointFilter interface {
	// Matches takes a datapoint and returns whether it is matched by the
	// filter
	Matches(*datapoint.Datapoint) bool
}

DatapointFilter can be used to filter out datapoints

func New

func New(monitorType string, metricNames []string, dimensions map[string]string, negated bool) (DatapointFilter, error)

New returns a new filter with the given configuration

type FilterSet

type FilterSet struct {
	ExcludeFilters []DatapointFilter
	IncludeFilters []DatapointFilter
}

FilterSet is a collection of datapont filters, any one of which must match for a datapoint to be matched.

func (*FilterSet) Matches

func (fs *FilterSet) Matches(dp *datapoint.Datapoint) bool

Matches sends a datapoint through each of the filters in the set and returns true if at least one of them matches the datapoint.