interfaces

Documentation

Index

• type Evaluator
• type Function
• type FunctionBase
  • func (b *FunctionBase) GetEvaluator() Evaluator
  • func (b *FunctionBase) SetEvaluator(evaluator Evaluator)
• type FunctionMetadata
• type Order
• type RewriteFunction
• type RewriteFunctionMetadata

Types

type Evaluator

type Evaluator interface {
	// Fetch populates the values map being passed into it by translating input expressions into a series of
	// parser.MetricRequest and fetching the raw data from the configured backend.
	//
	// It returns a map of only the data requested in the current invocation, scaled to a common step.
	Fetch(ctx context.Context, e []parser.Expr, from, until int64, values map[parser.MetricRequest][]*types.MetricData) (map[parser.MetricRequest][]*types.MetricData, error)
	// Eval uses the raw data within the values map being passed into it to in order to evaluate the input expression.
	Eval(ctx context.Context, e parser.Expr, from, until int64, values map[parser.MetricRequest][]*types.MetricData) ([]*types.MetricData, error)
}

Evaluator is an interface for any existing expression parser.

type Function

type Function interface {
	SetEvaluator(evaluator Evaluator)
	GetEvaluator() Evaluator
	Do(ctx context.Context, e parser.Expr, from, until int64, values map[parser.MetricRequest][]*types.MetricData) ([]*types.MetricData, error)
	Description() map[string]types.FunctionDescription
}

Function is interface that all graphite functions should follow

type FunctionBase

type FunctionBase struct {
	Evaluator Evaluator
}

FunctionBase is a set of base methods that partly satisfy Function interface and most probably nobody will modify

func (*FunctionBase) GetEvaluator

func (b *FunctionBase) GetEvaluator() Evaluator

GetEvaluator returns evaluator

func (*FunctionBase) SetEvaluator

func (b *FunctionBase) SetEvaluator(evaluator Evaluator)

SetEvaluator sets evaluator

type FunctionMetadata

type FunctionMetadata struct {
	Name     string
	Filename string
	Order    Order
	F        Function
}

type Order

type Order int

const (
	Any Order = iota
	Last
)

type RewriteFunction

type RewriteFunction interface {
	SetEvaluator(evaluator Evaluator)
	GetEvaluator() Evaluator
	Do(ctx context.Context, e parser.Expr, from, until int64, values map[parser.MetricRequest][]*types.MetricData) (bool, []string, error)
	Description() map[string]types.FunctionDescription
}

RewriteFunction is interface that graphite functions that rewrite expressions should follow

type RewriteFunctionMetadata

type RewriteFunctionMetadata struct {
	Name     string
	Filename string
	Order    Order
	F        RewriteFunction
}