github.com/go-graphite/carbonapi@v0.17.0/expr/functions/scaleToSeconds/function.go (about)

     1  package scaleToSeconds
     2  
     3  import (
     4  	"context"
     5  	"strconv"
     6  
     7  	"github.com/go-graphite/carbonapi/expr/helper"
     8  	"github.com/go-graphite/carbonapi/expr/interfaces"
     9  	"github.com/go-graphite/carbonapi/expr/types"
    10  	"github.com/go-graphite/carbonapi/pkg/parser"
    11  )
    12  
    13  type scaleToSeconds struct{}
    14  
    15  func GetOrder() interfaces.Order {
    16  	return interfaces.Any
    17  }
    18  
    19  func New(configFile string) []interfaces.FunctionMetadata {
    20  	res := make([]interfaces.FunctionMetadata, 0)
    21  	f := &scaleToSeconds{}
    22  	functions := []string{"scaleToSeconds"}
    23  	for _, n := range functions {
    24  		res = append(res, interfaces.FunctionMetadata{Name: n, F: f})
    25  	}
    26  	return res
    27  }
    28  
    29  // scaleToSeconds(seriesList, seconds)
    30  func (f *scaleToSeconds) Do(ctx context.Context, eval interfaces.Evaluator, e parser.Expr, from, until int64, values map[parser.MetricRequest][]*types.MetricData) ([]*types.MetricData, error) {
    31  	if e.ArgsLen() < 2 {
    32  		return nil, parser.ErrMissingArgument
    33  	}
    34  
    35  	arg, err := helper.GetSeriesArg(ctx, eval, e.Arg(0), from, until, values)
    36  	if err != nil {
    37  		return nil, err
    38  	}
    39  	seconds, err := e.GetFloatArg(1)
    40  	if err != nil {
    41  		return nil, err
    42  	}
    43  	secondsStr := strconv.Itoa(int(seconds))
    44  
    45  	results := make([]*types.MetricData, len(arg))
    46  
    47  	for j, a := range arg {
    48  		r := a.CopyLink()
    49  		r.Name = "scaleToSeconds(" + a.Name + "," + secondsStr + ")"
    50  		r.Values = make([]float64, len(a.Values))
    51  		r.Tags["scaleToSeconds"] = secondsStr
    52  
    53  		factor := seconds / float64(a.StepTime)
    54  
    55  		for i, v := range a.Values {
    56  			r.Values[i] = v * factor
    57  		}
    58  
    59  		results[j] = r
    60  	}
    61  	return results, nil
    62  }
    63  
    64  // Description is auto-generated description, based on output of https://github.com/graphite-project/graphite-web
    65  func (f *scaleToSeconds) Description() map[string]types.FunctionDescription {
    66  	return map[string]types.FunctionDescription{
    67  		"scaleToSeconds": {
    68  			Description: "Takes one metric or a wildcard seriesList and returns \"value per seconds\" where\nseconds is a last argument to this functions.\n\nUseful in conjunction with derivative or integral function if you want\nto normalize its result to a known resolution for arbitrary retentions",
    69  			Function:    "scaleToSeconds(seriesList, seconds)",
    70  			Group:       "Transform",
    71  			Module:      "graphite.render.functions",
    72  			Name:        "scaleToSeconds",
    73  			Params: []types.FunctionParam{
    74  				{
    75  					Name:     "seriesList",
    76  					Required: true,
    77  					Type:     types.SeriesList,
    78  				},
    79  				{
    80  					Name:     "seconds",
    81  					Required: true,
    82  					Type:     types.Integer,
    83  				},
    84  			},
    85  			NameChange:   true, // name changed
    86  			ValuesChange: true, // values changed
    87  		},
    88  	}
    89  }