mirror of
https://github.com/ethereum/go-ethereum.git
synced 2026-02-26 07:37:20 +00:00
9045b79bc2
This PR modifies how the metrics library handles `Enabled`: previously, the package `init` decided whether to serve real metrics or just dummy-types. This has several drawbacks: - During pkg init, we need to determine whether metrics are enabled or not. So we first hacked in a check if certain geth-specific commandline-flags were enabled. Then we added a similar check for geth-env-vars. Then we almost added a very elaborate check for toml-config-file, plus toml parsing. - Using "real" types and dummy types interchangeably means that everything is hidden behind interfaces. This has a performance penalty, and also it just adds a lot of code. This PR removes the interface stuff, uses concrete types, and allows for the setting of Enabled to happen later. It is still assumed that `metrics.Enable()` is invoked early on. The somewhat 'heavy' operations, such as ticking meters and exp-decay, now checks the enable-flag to prevent resource leak. The change may be large, but it's mostly pretty trivial, and from the last time I gutted the metrics, I ensured that we have fairly good test coverage. --------- Co-authored-by: Felix Lange <fjl@twurst.com>
64 lines
1.5 KiB
Go
64 lines
1.5 KiB
Go
package metrics
|
|
|
|
import (
|
|
"encoding/json"
|
|
"sync"
|
|
)
|
|
|
|
// GaugeInfoValue is a mapping of keys to values
|
|
type GaugeInfoValue map[string]string
|
|
|
|
func (val GaugeInfoValue) String() string {
|
|
data, _ := json.Marshal(val)
|
|
return string(data)
|
|
}
|
|
|
|
// GetOrRegisterGaugeInfo returns an existing GaugeInfo or constructs and registers a
|
|
// new GaugeInfo.
|
|
func GetOrRegisterGaugeInfo(name string, r Registry) *GaugeInfo {
|
|
if nil == r {
|
|
r = DefaultRegistry
|
|
}
|
|
return r.GetOrRegister(name, NewGaugeInfo()).(*GaugeInfo)
|
|
}
|
|
|
|
// NewGaugeInfo constructs a new GaugeInfo.
|
|
func NewGaugeInfo() *GaugeInfo {
|
|
return &GaugeInfo{
|
|
value: GaugeInfoValue{},
|
|
}
|
|
}
|
|
|
|
// NewRegisteredGaugeInfo constructs and registers a new GaugeInfo.
|
|
func NewRegisteredGaugeInfo(name string, r Registry) *GaugeInfo {
|
|
c := NewGaugeInfo()
|
|
if nil == r {
|
|
r = DefaultRegistry
|
|
}
|
|
r.Register(name, c)
|
|
return c
|
|
}
|
|
|
|
// gaugeInfoSnapshot is a read-only copy of another GaugeInfo.
|
|
type GaugeInfoSnapshot GaugeInfoValue
|
|
|
|
// Value returns the value at the time the snapshot was taken.
|
|
func (g GaugeInfoSnapshot) Value() GaugeInfoValue { return GaugeInfoValue(g) }
|
|
|
|
// GaugeInfo maintains a set of key/value mappings.
|
|
type GaugeInfo struct {
|
|
mutex sync.Mutex
|
|
value GaugeInfoValue
|
|
}
|
|
|
|
// Snapshot returns a read-only copy of the gauge.
|
|
func (g *GaugeInfo) Snapshot() GaugeInfoSnapshot {
|
|
return GaugeInfoSnapshot(g.value)
|
|
}
|
|
|
|
// Update updates the gauge's value.
|
|
func (g *GaugeInfo) Update(v GaugeInfoValue) {
|
|
g.mutex.Lock()
|
|
defer g.mutex.Unlock()
|
|
g.value = v
|
|
}
|