expr

package
v0.13.1 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Nov 28, 2019 License: AGPL-3.0, BSD-2-Clause Imports: 19 Imported by: 0

Documentation

Overview

argument types. to let functions describe their inputs and outputs

Index

Constants

This section is empty.

Variables

View Source 
var (
	ErrMissingArg          = errors.NewBadRequest("argument missing")
	ErrTooManyArg          = errors.NewBadRequest("too many arguments")
	ErrMissingTimeseries   = errors.NewBadRequest("missing time series argument")
	ErrWildcardNotAllowed  = errors.NewBadRequest("found wildcard where series expected")
	ErrMissingExpr         = errors.NewBadRequest("missing expression")
	ErrMissingComma        = errors.NewBadRequest("missing comma")
	ErrMissingQuote        = errors.NewBadRequest("missing quote")
	ErrUnexpectedCharacter = errors.NewBadRequest("unexpected character")
	ErrIllegalCharacter    = errors.NewBadRequest("illegal character for function name")
)
View Source 
var ErrIntPositive = errors.NewBadRequest("integer must be positive")
View Source 
var ErrInvalidAggFunc = errors.NewBadRequest("Invalid aggregation func")
View Source 
var ErrNonNegativePercent = errors.NewBadRequest("The requested percent is required to be greater than 0")

Functions

func IntPositive 

func IntPositive(e *expr) error

IntPositive validates whether an int is positive (greater than zero)

func IsAggFunc 

func IsAggFunc(e *expr) error

func IsConsolFunc 

func IsConsolFunc(e *expr) error

func IsIntervalString 

func IsIntervalString(e *expr) error

func IsOperator 

func IsOperator(e *expr) error

func NewAggregateConstructor 

func NewAggregateConstructor(aggDescription string, aggFunc crossSeriesAggFunc) func() GraphiteFunc

NewAggregateConstructor takes an agg string and returns a constructor function

func NewConsolidateByConstructor added in v0.12.0 

func NewConsolidateByConstructor(by string) func() GraphiteFunc

func NewFilterSeriesConstructor added in v0.12.0 

func NewFilterSeriesConstructor(fn string, operator string) func() GraphiteFunc

func NewHighestLowestConstructor 

func NewHighestLowestConstructor(fn string, highest bool) func() GraphiteFunc

func NewRemoveAboveBelowPercentileConstructor 

func NewRemoveAboveBelowPercentileConstructor(above bool) func() GraphiteFunc

func NewRemoveAboveBelowValueConstructor 

func NewRemoveAboveBelowValueConstructor(above bool) func() GraphiteFunc

func NewSortByConstructor 

func NewSortByConstructor(fn string, reverse bool) func() GraphiteFunc

func NonNegativePercent 

func NonNegativePercent(e *expr) error

func Parse 

func Parse(e string) (*expr, string, error)

Parses an expression string and turns it into an expression also returns any leftover data that could not be parsed

func ParseMany 

func ParseMany(targets []string) ([]*expr, error)

ParseMany parses a slice of strings into a slice of expressions (recursively) not included: validation that requested functions exist, correct args are passed, etc.

func Pool 

func Pool(p *sync.Pool)

Pool tells the expr library which pool to use for temporary []schema.Point this lets the expr package effectively create and drop point slices as needed it is recommended you use the same pool in your application, e.g. to get slices when loading the initial data, and to return the buffers back to the pool once the output from this package's processing is no longer needed.

func SortSeriesWithConsolidator 

func SortSeriesWithConsolidator(series []models.Series, c consolidation.Consolidator, reverse bool)

Types

type Arg 

type Arg interface {
	Key() string
	Optional() bool
}

Arg is an argument to a GraphiteFunc note how every implementation has a val property. this property should point to value accessible to the function. the value will be set up by the planner; it assures that by the time Func.Exec() is called, the function has access to all needed inputs, whether simple values, or in the case of ArgSeries* inputs other functions to call which will feed it data.

type ArgBool 

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

True or False

func (ArgBool) Key 

func (a ArgBool) Key() string

func (ArgBool) Optional 

func (a ArgBool) Optional() bool

type ArgFloat 

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

floating point number; potentially with decimals

func (ArgFloat) Key 

func (a ArgFloat) Key() string

func (ArgFloat) Optional 

func (a ArgFloat) Optional() bool

type ArgIn 

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

ArgIn is a special type that allows one of multiple arguments

func (ArgIn) Key 

func (a ArgIn) Key() string

func (ArgIn) Optional 

func (a ArgIn) Optional() bool

type ArgInt 

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

ArgInt is a number without decimals

func (ArgInt) Key 

func (a ArgInt) Key() string

func (ArgInt) Optional 

func (a ArgInt) Optional() bool

type ArgInts 

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

ArgInts represents one or more numbers without decimals

func (ArgInts) Key 

func (a ArgInts) Key() string

func (ArgInts) Optional 

func (a ArgInts) Optional() bool

type ArgQuotelessString added in v0.13.1 

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

When an argument is a special value without quotes (such as None or INF) This should NOT be used together with ArgSeries, ArgSeriesList, ArgSeriesLists inside an ArgIn as that causes ambiguity

func (ArgQuotelessString) Key added in v0.13.1 

func (a ArgQuotelessString) Key() string

func (ArgQuotelessString) Optional added in v0.13.1 

func (a ArgQuotelessString) Optional() bool

type ArgRegex 

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

like string, but should result in a regex

func (ArgRegex) Key 

func (a ArgRegex) Key() string

func (ArgRegex) Optional 

func (a ArgRegex) Optional() bool

type ArgSeries 

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

ArgSeries is a single series argument not generally used as input since graphite functions typically take multiple series as input but is useful to describe output

func (ArgSeries) Key 

func (a ArgSeries) Key() string

func (ArgSeries) Optional 

func (a ArgSeries) Optional() bool

type ArgSeriesList 

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

ArgSeriesList is a list of series argument, it can be 0..N series

func (ArgSeriesList) Key 

func (a ArgSeriesList) Key() string

func (ArgSeriesList) Optional 

func (a ArgSeriesList) Optional() bool

type ArgSeriesLists 

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

ArgSeriesLists represents one or more lists of series inputs.

func (ArgSeriesLists) Key 

func (a ArgSeriesLists) Key() string

func (ArgSeriesLists) Optional 

func (a ArgSeriesLists) Optional() bool

type ArgString 

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

string

func (ArgString) Key 

func (a ArgString) Key() string

func (ArgString) Optional 

func (a ArgString) Optional() bool

type ArgStrings 

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

ArgStrings represents one or more strings

func (ArgStrings) Key 

func (a ArgStrings) Key() string

func (ArgStrings) Optional 

func (a ArgStrings) Optional() bool

type ArgStringsOrInts 

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

Array of mixed strings or ints

func (ArgStringsOrInts) Key 

func (a ArgStringsOrInts) Key() string

func (ArgStringsOrInts) Optional 

func (a ArgStringsOrInts) Optional() bool

type Context 

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

Context describes a series timeframe and consolidator

type ErrBadArgument 

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

func (ErrBadArgument) Code added in v0.13.1 

func (e ErrBadArgument) Code() int

func (ErrBadArgument) Error 

func (e ErrBadArgument) Error() string

type ErrBadArgumentStr 

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

func (ErrBadArgumentStr) Code added in v0.13.1 

func (e ErrBadArgumentStr) Code() int

func (ErrBadArgumentStr) Error 

func (e ErrBadArgumentStr) Error() string

type ErrBadKwarg 

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

func (ErrBadKwarg) Code added in v0.13.1 

func (e ErrBadKwarg) Code() int

func (ErrBadKwarg) Error 

func (e ErrBadKwarg) Error() string

type ErrKwargSpecifiedTwice 

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

func (ErrKwargSpecifiedTwice) Code added in v0.13.1 

func (e ErrKwargSpecifiedTwice) Code() int

func (ErrKwargSpecifiedTwice) Error 

func (e ErrKwargSpecifiedTwice) Error() string

type ErrUnknownFunction 

type ErrUnknownFunction string

func (ErrUnknownFunction) Code added in v0.13.1 

func (e ErrUnknownFunction) Code() int

func (ErrUnknownFunction) Error 

func (e ErrUnknownFunction) Error() string

type ErrUnknownKwarg 

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

func (ErrUnknownKwarg) Code added in v0.13.1 

func (e ErrUnknownKwarg) Code() int

func (ErrUnknownKwarg) Error 

func (e ErrUnknownKwarg) Error() string

type FuncAbsolute added in v0.12.0 

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

func (*FuncAbsolute) Context added in v0.12.0 

func (s *FuncAbsolute) Context(context Context) Context

func (*FuncAbsolute) Exec added in v0.12.0 

func (s *FuncAbsolute) Exec(cache map[Req][]models.Series) ([]models.Series, error)

func (*FuncAbsolute) Signature added in v0.12.0 

func (s *FuncAbsolute) Signature() ([]Arg, []Arg)

type FuncAggregate 

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

func (*FuncAggregate) Context 

func (s *FuncAggregate) Context(context Context) Context

func (*FuncAggregate) Exec 

func (s *FuncAggregate) Exec(cache map[Req][]models.Series) ([]models.Series, error)

func (*FuncAggregate) Signature 

func (s *FuncAggregate) Signature() ([]Arg, []Arg)

type FuncAlias 

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

func (*FuncAlias) Context 

func (s *FuncAlias) Context(context Context) Context

func (*FuncAlias) Exec 

func (s *FuncAlias) Exec(cache map[Req][]models.Series) ([]models.Series, error)

func (*FuncAlias) Signature 

func (s *FuncAlias) Signature() ([]Arg, []Arg)

type FuncAliasByNode 

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

func (*FuncAliasByNode) Context 

func (s *FuncAliasByNode) Context(context Context) Context

func (*FuncAliasByNode) Exec 

func (s *FuncAliasByNode) Exec(cache map[Req][]models.Series) ([]models.Series, error)

func (*FuncAliasByNode) Signature 

func (s *FuncAliasByNode) Signature() ([]Arg, []Arg)

type FuncAliasSub 

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

func (*FuncAliasSub) Context 

func (s *FuncAliasSub) Context(context Context) Context

func (*FuncAliasSub) Exec 

func (s *FuncAliasSub) Exec(cache map[Req][]models.Series) ([]models.Series, error)

func (*FuncAliasSub) Signature 

func (s *FuncAliasSub) Signature() ([]Arg, []Arg)

type FuncAsPercent 

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

func (*FuncAsPercent) Context 

func (s *FuncAsPercent) Context(context Context) Context

func (*FuncAsPercent) Exec 

func (s *FuncAsPercent) Exec(cache map[Req][]models.Series) ([]models.Series, error)

func (*FuncAsPercent) Signature 

func (s *FuncAsPercent) Signature() ([]Arg, []Arg)

type FuncConsolidateBy 

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

func (*FuncConsolidateBy) Context 

func (s *FuncConsolidateBy) Context(context Context) Context

func (*FuncConsolidateBy) Exec 

func (s *FuncConsolidateBy) Exec(cache map[Req][]models.Series) ([]models.Series, error)

func (*FuncConsolidateBy) Signature 

func (s *FuncConsolidateBy) Signature() ([]Arg, []Arg)

type FuncCountSeries 

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

func (*FuncCountSeries) Context 

func (s *FuncCountSeries) Context(context Context) Context

func (*FuncCountSeries) Exec 

func (s *FuncCountSeries) Exec(cache map[Req][]models.Series) ([]models.Series, error)

func (*FuncCountSeries) Signature 

func (s *FuncCountSeries) Signature() ([]Arg, []Arg)

type FuncDerivative 

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

func (*FuncDerivative) Context 

func (s *FuncDerivative) Context(context Context) Context

func (*FuncDerivative) Exec 

func (s *FuncDerivative) Exec(cache map[Req][]models.Series) ([]models.Series, error)

func (*FuncDerivative) Signature 

func (s *FuncDerivative) Signature() ([]Arg, []Arg)

type FuncDivideSeries 

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

func (*FuncDivideSeries) Context 

func (s *FuncDivideSeries) Context(context Context) Context

func (*FuncDivideSeries) Exec 

func (s *FuncDivideSeries) Exec(cache map[Req][]models.Series) ([]models.Series, error)

func (*FuncDivideSeries) Signature 

func (s *FuncDivideSeries) Signature() ([]Arg, []Arg)

type FuncDivideSeriesLists 

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

func (*FuncDivideSeriesLists) Context 

func (s *FuncDivideSeriesLists) Context(context Context) Context

func (*FuncDivideSeriesLists) Exec 

func (s *FuncDivideSeriesLists) Exec(cache map[Req][]models.Series) ([]models.Series, error)

func (*FuncDivideSeriesLists) Signature 

func (s *FuncDivideSeriesLists) Signature() ([]Arg, []Arg)

type FuncFallbackSeries added in v0.13.0 

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

func (*FuncFallbackSeries) Context added in v0.13.0 

func (s *FuncFallbackSeries) Context(context Context) Context

func (*FuncFallbackSeries) Exec added in v0.13.0 

func (s *FuncFallbackSeries) Exec(cache map[Req][]models.Series) ([]models.Series, error)

func (*FuncFallbackSeries) Signature added in v0.13.0 

func (s *FuncFallbackSeries) Signature() ([]Arg, []Arg)

type FuncFilterSeries 

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

func (*FuncFilterSeries) Context 

func (s *FuncFilterSeries) Context(context Context) Context

func (*FuncFilterSeries) Exec 

func (s *FuncFilterSeries) Exec(cache map[Req][]models.Series) ([]models.Series, error)

func (*FuncFilterSeries) Signature 

func (s *FuncFilterSeries) Signature() ([]Arg, []Arg)

type FuncGet 

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

internal function just for getting data

func (FuncGet) Context 

func (s FuncGet) Context(context Context) Context

func (FuncGet) Exec 

func (s FuncGet) Exec(cache map[Req][]models.Series) ([]models.Series, error)

func (FuncGet) Signature 

func (s FuncGet) Signature() ([]Arg, []Arg)

type FuncGrep 

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

func (*FuncGrep) Context 

func (s *FuncGrep) Context(context Context) Context

func (*FuncGrep) Exec 

func (s *FuncGrep) Exec(cache map[Req][]models.Series) ([]models.Series, error)

func (*FuncGrep) Signature 

func (s *FuncGrep) Signature() ([]Arg, []Arg)

type FuncGroup added in v0.13.0 

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

func (*FuncGroup) Context added in v0.13.0 

func (s *FuncGroup) Context(context Context) Context

func (*FuncGroup) Exec added in v0.13.0 

func (s *FuncGroup) Exec(cache map[Req][]models.Series) ([]models.Series, error)

func (*FuncGroup) Signature added in v0.13.0 

func (s *FuncGroup) Signature() ([]Arg, []Arg)

type FuncGroupByTags 

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

func (*FuncGroupByTags) Context 

func (s *FuncGroupByTags) Context(context Context) Context

func (*FuncGroupByTags) Exec 

func (s *FuncGroupByTags) Exec(cache map[Req][]models.Series) ([]models.Series, error)

func (*FuncGroupByTags) Signature 

func (s *FuncGroupByTags) Signature() ([]Arg, []Arg)

type FuncHighestLowest 

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

func (*FuncHighestLowest) Context 

func (s *FuncHighestLowest) Context(context Context) Context

func (*FuncHighestLowest) Exec 

func (s *FuncHighestLowest) Exec(cache map[Req][]models.Series) ([]models.Series, error)

func (*FuncHighestLowest) Signature 

func (s *FuncHighestLowest) Signature() ([]Arg, []Arg)

type FuncIntegral added in v0.13.0 

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

func (*FuncIntegral) Context added in v0.13.0 

func (s *FuncIntegral) Context(context Context) Context

func (*FuncIntegral) Exec added in v0.13.0 

func (s *FuncIntegral) Exec(cache map[Req][]models.Series) ([]models.Series, error)

func (*FuncIntegral) Signature added in v0.13.0 

func (s *FuncIntegral) Signature() ([]Arg, []Arg)

type FuncIsNonNull 

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

func (*FuncIsNonNull) Context 

func (s *FuncIsNonNull) Context(context Context) Context

func (*FuncIsNonNull) Exec 

func (s *FuncIsNonNull) Exec(cache map[Req][]models.Series) ([]models.Series, error)

func (*FuncIsNonNull) Signature 

func (s *FuncIsNonNull) Signature() ([]Arg, []Arg)

type FuncKeepLastValue 

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

func (*FuncKeepLastValue) Context 

func (s *FuncKeepLastValue) Context(context Context) Context

func (*FuncKeepLastValue) Exec 

func (s *FuncKeepLastValue) Exec(cache map[Req][]models.Series) ([]models.Series, error)

func (*FuncKeepLastValue) Signature 

func (s *FuncKeepLastValue) Signature() ([]Arg, []Arg)

type FuncMovingAverage 

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

func (*FuncMovingAverage) Context 

func (s *FuncMovingAverage) Context(context Context) Context

func (*FuncMovingAverage) Exec 

func (s *FuncMovingAverage) Exec(cache map[Req][]models.Series) ([]models.Series, error)

func (*FuncMovingAverage) Signature 

func (s *FuncMovingAverage) Signature() ([]Arg, []Arg)

note if input is 1 series, then output is too. not sure how to communicate that

type FuncNonNegativeDerivative 

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

func (*FuncNonNegativeDerivative) Context 

func (s *FuncNonNegativeDerivative) Context(context Context) Context

func (*FuncNonNegativeDerivative) Exec 

func (s *FuncNonNegativeDerivative) Exec(cache map[Req][]models.Series) ([]models.Series, error)

func (*FuncNonNegativeDerivative) Signature 

func (s *FuncNonNegativeDerivative) Signature() ([]Arg, []Arg)

type FuncPerSecond 

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

func (*FuncPerSecond) Context 

func (s *FuncPerSecond) Context(context Context) Context

func (*FuncPerSecond) Exec 

func (s *FuncPerSecond) Exec(cache map[Req][]models.Series) ([]models.Series, error)

func (*FuncPerSecond) Signature 

func (s *FuncPerSecond) Signature() ([]Arg, []Arg)

type FuncRemoveAboveBelowPercentile 

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

func (*FuncRemoveAboveBelowPercentile) Context 

func (s *FuncRemoveAboveBelowPercentile) Context(context Context) Context

func (*FuncRemoveAboveBelowPercentile) Exec 

func (s *FuncRemoveAboveBelowPercentile) Exec(cache map[Req][]models.Series) ([]models.Series, error)

func (*FuncRemoveAboveBelowPercentile) Signature 

func (s *FuncRemoveAboveBelowPercentile) Signature() ([]Arg, []Arg)

type FuncRemoveAboveBelowValue 

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

func (*FuncRemoveAboveBelowValue) Context 

func (s *FuncRemoveAboveBelowValue) Context(context Context) Context

func (*FuncRemoveAboveBelowValue) Exec 

func (s *FuncRemoveAboveBelowValue) Exec(cache map[Req][]models.Series) ([]models.Series, error)

func (*FuncRemoveAboveBelowValue) Signature 

func (s *FuncRemoveAboveBelowValue) Signature() ([]Arg, []Arg)

type FuncScale 

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

func (*FuncScale) Context 

func (s *FuncScale) Context(context Context) Context

func (*FuncScale) Exec 

func (s *FuncScale) Exec(cache map[Req][]models.Series) ([]models.Series, error)

func (*FuncScale) Signature 

func (s *FuncScale) Signature() ([]Arg, []Arg)

type FuncScaleToSeconds 

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

func (*FuncScaleToSeconds) Context 

func (s *FuncScaleToSeconds) Context(context Context) Context

func (*FuncScaleToSeconds) Exec 

func (s *FuncScaleToSeconds) Exec(cache map[Req][]models.Series) ([]models.Series, error)

func (*FuncScaleToSeconds) Signature 

func (s *FuncScaleToSeconds) Signature() ([]Arg, []Arg)

type FuncSmartSummarize 

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

func (*FuncSmartSummarize) Context 

func (s *FuncSmartSummarize) Context(context Context) Context

func (*FuncSmartSummarize) Exec 

func (s *FuncSmartSummarize) Exec(cache map[Req][]models.Series) ([]models.Series, error)

func (*FuncSmartSummarize) Signature 

func (s *FuncSmartSummarize) Signature() ([]Arg, []Arg)

type FuncSortBy 

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

func (*FuncSortBy) Context 

func (s *FuncSortBy) Context(context Context) Context

func (*FuncSortBy) Exec 

func (s *FuncSortBy) Exec(cache map[Req][]models.Series) ([]models.Series, error)

func (*FuncSortBy) Signature 

func (s *FuncSortBy) Signature() ([]Arg, []Arg)

type FuncSortByName 

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

func (*FuncSortByName) Context 

func (s *FuncSortByName) Context(context Context) Context

func (*FuncSortByName) Exec 

func (s *FuncSortByName) Exec(cache map[Req][]models.Series) ([]models.Series, error)

func (*FuncSortByName) Signature 

func (s *FuncSortByName) Signature() ([]Arg, []Arg)

type FuncSummarize 

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

func (*FuncSummarize) Context 

func (s *FuncSummarize) Context(context Context) Context

func (*FuncSummarize) Exec 

func (s *FuncSummarize) Exec(cache map[Req][]models.Series) ([]models.Series, error)

func (*FuncSummarize) Signature 

func (s *FuncSummarize) Signature() ([]Arg, []Arg)

type FuncTransformNull 

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

func (*FuncTransformNull) Context 

func (s *FuncTransformNull) Context(context Context) Context

func (*FuncTransformNull) Exec 

func (s *FuncTransformNull) Exec(cache map[Req][]models.Series) ([]models.Series, error)

func (*FuncTransformNull) Signature 

func (s *FuncTransformNull) Signature() ([]Arg, []Arg)

type GraphiteFunc 

type GraphiteFunc interface {
	// Signature declares input and output arguments (return values)
	// input args can be optional in which case they can be specified positionally or via keys if you want to specify params that come after un-specified optional params
	// the val pointers of each input Arg should point to a location accessible to the function,
	// so that the planner can set up the inputs for your function based on user input.
	// NewPlan() will only create the plan if the expressions it parsed correspond to the signatures provided by the function
	Signature() ([]Arg, []Arg)

	// Context allows a func to alter the context that will be passed down the expression tree.
	// this function will be called after validating and setting up all non-series and non-serieslist parameters.
	// (as typically, context alterations require integer/string/bool/etc parameters, and shall affect series[list] parameters)
	// examples:
	// * movingAverage(foo,5min) -> the 5min arg will be parsed, so we can request 5min of earlier data, which will affect the request for foo.
	// * consolidateBy(bar, "sum") -> the "sum" arg will be parsed, so we can pass on the fact that bar needs to be sum-consolidated
	Context(c Context) Context
	// Exec executes the function. the function should call any input functions, do its processing, and return output.
	// IMPORTANT: for performance and correctness, functions should
	// * not modify slices of points that they get from their inputs
	// * use the pool to get new slices in which to store any new/modified dat
	// * add the newly created slices into the cache so they can be reclaimed after the output is consumed
	// * not modify other properties on its input series, such as Tags map or Meta
	Exec(map[Req][]models.Series) ([]models.Series, error)
}

GraphiteFunc defines a graphite processing function

func NewAbsolute added in v0.12.0 

func NewAbsolute() GraphiteFunc

func NewAlias 

func NewAlias() GraphiteFunc

func NewAliasByNode 

func NewAliasByNode() GraphiteFunc

func NewAliasSub 

func NewAliasSub() GraphiteFunc

func NewAsPercent 

func NewAsPercent() GraphiteFunc

func NewConsolidateBy 

func NewConsolidateBy() GraphiteFunc

func NewCountSeries 

func NewCountSeries() GraphiteFunc

func NewDerivative 

func NewDerivative() GraphiteFunc

func NewDivideSeries 

func NewDivideSeries() GraphiteFunc

func NewDivideSeriesLists 

func NewDivideSeriesLists() GraphiteFunc

func NewExclude 

func NewExclude() GraphiteFunc

func NewFallbackSeries added in v0.13.0 

func NewFallbackSeries() GraphiteFunc

func NewFilterSeries 

func NewFilterSeries() GraphiteFunc

func NewGet 

func NewGet(req Req) GraphiteFunc

func NewGrep 

func NewGrep() GraphiteFunc

func NewGroup added in v0.13.0 

func NewGroup() GraphiteFunc

func NewGroupByTags 

func NewGroupByTags() GraphiteFunc

func NewIntegral added in v0.13.0 

func NewIntegral() GraphiteFunc

func NewIsNonNull 

func NewIsNonNull() GraphiteFunc

func NewKeepLastValue 

func NewKeepLastValue() GraphiteFunc

func NewMovingAverage 

func NewMovingAverage() GraphiteFunc

func NewNonNegativeDerivative 

func NewNonNegativeDerivative() GraphiteFunc

func NewPerSecond 

func NewPerSecond() GraphiteFunc

func NewScale 

func NewScale() GraphiteFunc

func NewScaleToSeconds 

func NewScaleToSeconds() GraphiteFunc

func NewSmartSummarize 

func NewSmartSummarize() GraphiteFunc

func NewSortByName 

func NewSortByName() GraphiteFunc

func NewSummarize 

func NewSummarize() GraphiteFunc

func NewTransformNull 

func NewTransformNull() GraphiteFunc

type MetricRequest 

type MetricRequest struct {
	Metric string
	From   int32
	Until  int32
}

type Plan 

type Plan struct {
	Reqs []Req // data that needs to be fetched before functions can be executed

	MaxDataPoints uint32
	From          uint32 // global request scoped from
	To            uint32 // global request scoped to
	// contains filtered or unexported fields
}

func NewPlan 

func NewPlan(exprs []*expr, from, to, mdp uint32, stable bool, reqs []Req) (Plan, error)

NewPlan validates the expressions and comes up with the initial (potentially non-optimal) execution plan which is just a list of requests and the expressions. traverse tree and as we go down: * make sure function exists * validation of arguments * allow functions to modify the Context (change data range or consolidation) * future version: allow functions to mark safe to pre-aggregate using consolidateBy or not

func (Plan) Clean 

func (p Plan) Clean()

Clean returns all buffers (all input data + generated series along the way) back to the pool.

func (Plan) Dump 

func (p Plan) Dump(w io.Writer)

func (Plan) Run 

func (p Plan) Run(input map[Req][]models.Series) ([]models.Series, error)

Run invokes all processing as specified in the plan (expressions, from/to) with the input as input

type Req 

type Req struct {
	Query string // whatever was parsed as the query out of a graphite target. e.g. target=sum(foo.{b,a}r.*) -> foo.{b,a}r.* -> this will go straight to index lookup
	From  uint32
	To    uint32
	Cons  consolidation.Consolidator // can be 0 to mean undefined
}

Req represents a request for one/more series

func NewReq 

func NewReq(query string, from, to uint32, cons consolidation.Consolidator) Req

NewReq creates a new Req. pass cons=0 to leave consolidator undefined, leaving up to the caller (in graphite's case, it would cause a lookup into storage-aggregation.conf)

type ScoredSeries 

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

type Validator 

type Validator func(e *expr) error

Validator is a function to validate an input

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.