go.chromium.org/luci@v0.0.0-20240309015107-7cdc2e660f33/common/tsmon/types/metric.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  	"time"
    19  
    20  	"go.chromium.org/luci/common/tsmon/distribution"
    21  )
    22  
    23  // Metric is the low-level interface provided by all metrics.
    24  // Concrete types are defined in the "metrics" package.
    25  type Metric interface {
    26  	Info() MetricInfo
    27  	Metadata() MetricMetadata
    28  
    29  	// SetFixedResetTime overrides the reset time for this metric.  Usually cells
    30  	// take the current time when they're first assigned a value, but it can be
    31  	// useful to override the reset time when tracking an external counter.
    32  	SetFixedResetTime(t time.Time)
    33  }
    34  
    35  // DistributionMetric is the low-level interface provided by all distribution
    36  // metrics.  It has a Bucketer which is responsible for assigning buckets to
    37  // samples.  Concrete types are defined in the "metrics" package.
    38  type DistributionMetric interface {
    39  	Metric
    40  
    41  	Bucketer() *distribution.Bucketer
    42  }