github.com/facebookincubator/go-belt@v0.0.0-20230703220935-39cd348f1a38/tool/experimental/metrics/implementation/simplemetrics/gauge.go (about)

     1  // Copyright 2022 Meta Platforms, Inc. and affiliates.
     2  //
     3  // Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
     4  //
     5  // 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
     6  //
     7  // 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
     8  //
     9  // 3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
    10  //
    11  // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
    12  
    13  // Copyright (c) Facebook, Inc. and its affiliates.
    14  //
    15  // This source code is licensed under the MIT license found in the
    16  // LICENSE file in the root directory of this source tree.
    17  
    18  package simplemetrics
    19  
    20  import (
    21  	"sync"
    22  
    23  	"github.com/facebookincubator/go-belt/tool/experimental/metrics/types"
    24  	"go.uber.org/atomic"
    25  )
    26  
    27  var (
    28  	_ types.Gauge = &Gauge{}
    29  )
    30  
    31  type gaugeFamily struct {
    32  	sync.RWMutex
    33  	Metrics map[string]*Gauge
    34  }
    35  
    36  func (family *gaugeFamily) get(fields AbstractFields) types.Gauge {
    37  	fieldsKey := fieldsToString(fields)
    38  
    39  	family.RLock()
    40  	metric := family.Metrics[fieldsKey]
    41  	family.RUnlock()
    42  	if metric != nil {
    43  		return metric
    44  	}
    45  
    46  	family.Lock()
    47  	defer family.Unlock()
    48  	metric = family.Metrics[fieldsKey]
    49  	if metric != nil {
    50  		return metric
    51  	}
    52  
    53  	metric = &Gauge{
    54  		Family: family,
    55  	}
    56  	family.Metrics[fieldsKey] = metric
    57  
    58  	return metric
    59  }
    60  
    61  // Gauge is a naive implementation of Gauge.
    62  type Gauge struct {
    63  	Family *gaugeFamily
    64  	atomic.Float64
    65  }
    66  
    67  // Add implements metrics.Gauge.
    68  func (metric *Gauge) Add(add float64) types.Gauge {
    69  	metric.Float64.Add(add)
    70  	return metric
    71  }
    72  
    73  // Value implements metrics.Gauge.
    74  func (metric *Gauge) Value() any {
    75  	return metric.Float64.Load()
    76  }
    77  
    78  // WithResetFields implements Gauge.
    79  func (metric *Gauge) WithResetFields(fields AbstractFields) types.Gauge {
    80  	return metric.Family.get(fields)
    81  }