filters

Documentation

Overview

Package filters provides API to implement goma filters.

Index

• Variables
• func Register(name string, ctor Constructor)
• type Constructor
• type Filter
  • func Construct(name string, params map[string]interface{}) (Filter, error)

Variables

var (
	ErrNotFound = errors.New("filter not found")
)

Errors for filters.

Functions

func Register

func Register(name string, ctor Constructor)

Register registers a constructor of a kind of filters.

Types

type Constructor

type Constructor func(params map[string]interface{}) (Filter, error)

Constructor is a function to create a filter.

params are configuration options for the probe.

type Filter

type Filter interface {
	// Init is called when goma starts monitoring.
	Init()

	// Put receives a return value from a probe, and returns a filtered value.
	Put(f float64) float64

	// String returns a descriptive string for this filter.
	String() string
}

Filter is the interface for filters.

func Construct

func Construct(name string, params map[string]interface{}) (Filter, error)

Construct constructs a named filter. This function is used internally in goma.