mirror of
https://github.com/hanzoai/tasks.git
synced 2026-10-04 02:04:03 +00:00
## What changed? <!-- Describe what has changed in this PR --> Added the build tag `debug` that builds the metric definition with the location of the metric definition. Add `GetResisteredMetricsDefinitions` to the `debug` build tag to retrieve the metrics registry. ## Why? <!-- Tell your future self why have you made these changes --> ## How did you test it? <!-- How have you verified this change? Tested locally? Added a unit test? Checked in staging env? --> ## Potential risks <!-- Assuming the worst case, what can be broken when deploying this change to production? --> ## Documentation <!-- Have you made sure this change doesn't falsify anything currently stated in `docs/`? If significant new behavior is added, have you described that in `docs/`? --> ## Is hotfix candidate? <!-- Is this PR a hotfix candidate or does it require a notification to be sent to the broader community? (Yes/No) --> Co-authored-by: Michael Snowden <[email protected]>
101 lines
3.3 KiB
Go
101 lines
3.3 KiB
Go
// The MIT License
|
|
//
|
|
// Copyright (c) 2020 Temporal Technologies Inc. All rights reserved.
|
|
//
|
|
// Copyright (c) 2020 Uber Technologies, Inc.
|
|
//
|
|
// Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
// of this software and associated documentation files (the "Software"), to deal
|
|
// in the Software without restriction, including without limitation the rights
|
|
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
// copies of the Software, and to permit persons to whom the Software is
|
|
// furnished to do so, subject to the following conditions:
|
|
//
|
|
// The above copyright notice and this permission notice shall be included in
|
|
// all copies or substantial portions of the Software.
|
|
//
|
|
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
|
// THE SOFTWARE.
|
|
|
|
package metrics
|
|
|
|
// types used/defined by the package
|
|
type (
|
|
histogramDefinition struct {
|
|
metricDefinition
|
|
}
|
|
|
|
counterDefinition struct {
|
|
metricDefinition
|
|
}
|
|
|
|
gaugeDefinition struct {
|
|
metricDefinition
|
|
}
|
|
|
|
timerDefinition struct {
|
|
metricDefinition
|
|
}
|
|
)
|
|
|
|
func NewTimerDef(name string, opts ...Option) timerDefinition {
|
|
// This line cannot be combined with others!
|
|
// This ensures the stack trace has information of the caller.
|
|
def := newMetricDefinition(name, append(opts, WithUnit(Milliseconds))...)
|
|
globalRegistry.register(def)
|
|
return timerDefinition{def}
|
|
}
|
|
|
|
func NewBytesHistogramDef(name string, opts ...Option) histogramDefinition {
|
|
// This line cannot be combined with others!
|
|
// This ensures the stack trace has information of the caller.
|
|
def := newMetricDefinition(name, append(opts, WithUnit(Bytes))...)
|
|
globalRegistry.register(def)
|
|
return histogramDefinition{def}
|
|
}
|
|
|
|
func NewDimensionlessHistogramDef(name string, opts ...Option) histogramDefinition {
|
|
// This line cannot be combined with others!
|
|
// This ensures the stack trace has information of the caller.
|
|
def := newMetricDefinition(name, append(opts, WithUnit(Dimensionless))...)
|
|
globalRegistry.register(def)
|
|
return histogramDefinition{def}
|
|
}
|
|
|
|
func NewCounterDef(name string, opts ...Option) counterDefinition {
|
|
// This line cannot be combined with others!
|
|
// This ensures the stack trace has information of the caller.
|
|
def := newMetricDefinition(name, opts...)
|
|
globalRegistry.register(def)
|
|
return counterDefinition{def}
|
|
}
|
|
|
|
func NewGaugeDef(name string, opts ...Option) gaugeDefinition {
|
|
// This line cannot be combined with others!
|
|
// This ensures the stack trace has information of the caller.
|
|
def := newMetricDefinition(name, opts...)
|
|
globalRegistry.register(def)
|
|
return gaugeDefinition{def}
|
|
}
|
|
|
|
func (d histogramDefinition) With(handler Handler) HistogramIface {
|
|
return handler.Histogram(d.name, d.unit)
|
|
}
|
|
|
|
func (d counterDefinition) With(handler Handler) CounterIface {
|
|
return handler.Counter(d.name)
|
|
}
|
|
|
|
func (d gaugeDefinition) With(handler Handler) GaugeIface {
|
|
return handler.Gauge(d.name)
|
|
}
|
|
|
|
func (d timerDefinition) With(handler Handler) TimerIface {
|
|
return handler.Timer(d.name)
|
|
}
|