github.com/m3db/m3@v1.5.1-0.20231129193456-75a402aa583b/src/query/graphite/ts/consolidation_approach.go (about)

     1  // Copyright (c) 2019 Uber Technologies, Inc.
     2  //
     3  // Permission is hereby granted, free of charge, to any person obtaining a copy
     4  // of this software and associated documentation files (the "Software"), to deal
     5  // in the Software without restriction, including without limitation the rights
     6  // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
     7  // copies of the Software, and to permit persons to whom the Software is
     8  // furnished to do so, subject to the following conditions:
     9  //
    10  // The above copyright notice and this permission notice shall be included in
    11  // all copies or substantial portions of the Software.
    12  //
    13  // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
    14  // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
    15  // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
    16  // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
    17  // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
    18  // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
    19  // THE SOFTWARE.
    20  
    21  package ts
    22  
    23  import (
    24  	"fmt"
    25  )
    26  
    27  // ConsolidationApproach defines an approach to consolidating multiple datapoints
    28  type ConsolidationApproach string
    29  
    30  // The standard set of consolidation functions
    31  const (
    32  	ConsolidationAvg     ConsolidationApproach = "avg"
    33  	ConsolidationMin     ConsolidationApproach = "min"
    34  	ConsolidationMax     ConsolidationApproach = "max"
    35  	ConsolidationSum     ConsolidationApproach = "sum"
    36  	ConsolidationAverage ConsolidationApproach = "average" // just an alias to avg but for backward-compatibility
    37  	ConsolidationLast    ConsolidationApproach = "last"
    38  )
    39  
    40  // SafeFunc returns a boolean indicating whether this is a valid consolidation approach,
    41  // and if so, the corresponding ConsolidationFunc.
    42  func (ca ConsolidationApproach) SafeFunc() (ConsolidationFunc, bool) {
    43  	f, ok := consolidationFuncs[ca]
    44  	return f, ok
    45  }
    46  
    47  // Func returns the ConsolidationFunc implementing the ConsolidationApproach
    48  func (ca ConsolidationApproach) Func() ConsolidationFunc {
    49  	f, ok := ca.SafeFunc()
    50  	if !ok {
    51  		panic(fmt.Sprintf("No consolidation func for %s", ca))
    52  	}
    53  
    54  	return f
    55  }
    56  
    57  var (
    58  	consolidationFuncs = map[ConsolidationApproach]ConsolidationFunc{
    59  		ConsolidationAvg:     Avg,
    60  		ConsolidationAverage: Avg,
    61  		ConsolidationMin:     Min,
    62  		ConsolidationMax:     Max,
    63  		ConsolidationSum:     Sum,
    64  		ConsolidationLast:    Last,
    65  	}
    66  )