go.temporal.io/server@v1.23.0/common/metrics/noop_impl.go (about)

     1  // The MIT License
     2  //
     3  // Copyright (c) 2020 Temporal Technologies Inc.  All rights reserved.
     4  //
     5  // Copyright (c) 2020 Uber Technologies, Inc.
     6  //
     7  // Permission is hereby granted, free of charge, to any person obtaining a copy
     8  // of this software and associated documentation files (the "Software"), to deal
     9  // in the Software without restriction, including without limitation the rights
    10  // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
    11  // copies of the Software, and to permit persons to whom the Software is
    12  // furnished to do so, subject to the following conditions:
    13  //
    14  // The above copyright notice and this permission notice shall be included in
    15  // all copies or substantial portions of the Software.
    16  //
    17  // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
    18  // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
    19  // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
    20  // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
    21  // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
    22  // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
    23  // THE SOFTWARE.
    24  
    25  package metrics
    26  
    27  import (
    28  	"time"
    29  
    30  	"go.temporal.io/server/common/log"
    31  )
    32  
    33  var (
    34  	NoopMetricsHandler Handler = newNoopMetricsHandler()
    35  )
    36  
    37  type (
    38  	noopMetricsHandler struct{}
    39  )
    40  
    41  func newNoopMetricsHandler() *noopMetricsHandler { return &noopMetricsHandler{} }
    42  
    43  // WithTags creates a new MetricProvder with provided []Tag
    44  // Tags are merged with registered Tags from the source MetricsHandler
    45  func (n *noopMetricsHandler) WithTags(...Tag) Handler {
    46  	return n
    47  }
    48  
    49  // Counter obtains a counter for the given name.
    50  func (*noopMetricsHandler) Counter(string) CounterIface {
    51  	return NoopCounterMetricFunc
    52  }
    53  
    54  // Gauge obtains a gauge for the given name.
    55  func (*noopMetricsHandler) Gauge(string) GaugeIface {
    56  	return NoopGaugeMetricFunc
    57  }
    58  
    59  // Timer obtains a timer for the given name.
    60  func (*noopMetricsHandler) Timer(string) TimerIface {
    61  	return NoopTimerMetricFunc
    62  }
    63  
    64  // Histogram obtains a histogram for the given name.
    65  func (*noopMetricsHandler) Histogram(string, MetricUnit) HistogramIface {
    66  	return NoopHistogramMetricFunc
    67  }
    68  
    69  func (*noopMetricsHandler) Stop(log.Logger) {}
    70  
    71  var NoopCounterMetricFunc = CounterFunc(func(i int64, t ...Tag) {})
    72  var NoopGaugeMetricFunc = GaugeFunc(func(f float64, t ...Tag) {})
    73  var NoopTimerMetricFunc = TimerFunc(func(d time.Duration, t ...Tag) {})
    74  var NoopHistogramMetricFunc = HistogramFunc(func(i int64, t ...Tag) {})