go.chromium.org/luci@v0.0.0-20240309015107-7cdc2e660f33/common/tsmon/types/value_type.go (about)

     1  // Copyright 2015 The LUCI Authors.
     2  //
     3  // Licensed under the Apache License, Version 2.0 (the "License");
     4  // you may not use this file except in compliance with the License.
     5  // You may obtain a copy of the License at
     6  //
     7  //      http://www.apache.org/licenses/LICENSE-2.0
     8  //
     9  // Unless required by applicable law or agreed to in writing, software
    10  // distributed under the License is distributed on an "AS IS" BASIS,
    11  // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    12  // See the License for the specific language governing permissions and
    13  // limitations under the License.
    14  
    15  package types
    16  
    17  import (
    18  	"fmt"
    19  )
    20  
    21  // ValueType is an enum for the type of a metric.
    22  type ValueType int
    23  
    24  // Types of metric values.
    25  const (
    26  	NonCumulativeIntType ValueType = iota
    27  	CumulativeIntType
    28  	NonCumulativeFloatType
    29  	CumulativeFloatType
    30  	StringType
    31  	BoolType
    32  	NonCumulativeDistributionType
    33  	CumulativeDistributionType
    34  )
    35  
    36  func (v ValueType) String() string {
    37  	switch v {
    38  	case NonCumulativeIntType:
    39  		return "NonCumulativeIntType"
    40  	case CumulativeIntType:
    41  		return "CumulativeIntType"
    42  	case NonCumulativeFloatType:
    43  		return "NonCumulativeFloatType"
    44  	case CumulativeFloatType:
    45  		return "CumulativeFloatType"
    46  	case StringType:
    47  		return "StringType"
    48  	case BoolType:
    49  		return "BoolType"
    50  	case NonCumulativeDistributionType:
    51  		return "NonCumulativeDistributionType"
    52  	case CumulativeDistributionType:
    53  		return "CumulativeDistributionType"
    54  	}
    55  	panic(fmt.Sprintf("unknown ValueType %d", v))
    56  }
    57  
    58  // IsCumulative returns true if this is a cumulative metric value type.
    59  func (v ValueType) IsCumulative() bool {
    60  	return v == CumulativeIntType ||
    61  		v == CumulativeFloatType ||
    62  		v == CumulativeDistributionType
    63  }