go.chromium.org/luci@v0.0.0-20240309015107-7cdc2e660f33/common/tsmon/types/cell.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/field"
    21  )
    22  
    23  // Cell is the smallest unit of data recorded by tsmon.  Metrics can be
    24  // thought of as multi-dimensional maps (with fields defining the dimensions) -
    25  // a Cell is one value in that map, with information about its fields and its
    26  // type.
    27  type Cell struct {
    28  	MetricInfo
    29  	MetricMetadata
    30  	CellData
    31  }
    32  
    33  // MetricInfo contains the definition of a metric.
    34  type MetricInfo struct {
    35  	Name        string
    36  	Description string
    37  	Fields      []field.Field
    38  	ValueType   ValueType
    39  	TargetType  TargetType
    40  }
    41  
    42  // MetricMetadata contains user-provided metadata for a metric.
    43  type MetricMetadata struct {
    44  	Units MetricDataUnits // the unit of recorded data for a given metric.
    45  }
    46  
    47  // CellData contains the value of a single cell.
    48  type CellData struct {
    49  	FieldVals []any
    50  	Target    Target
    51  	ResetTime time.Time
    52  	Value     any
    53  }