8b6cf128af
This change includes a lot of things, listed below.
### Split up interfaces, write vs read
The interfaces have been split up into one write-interface and one read-interface, with `Snapshot` being the gateway from write to read. This simplifies the semantics _a lot_.
Example of splitting up an interface into one readonly 'snapshot' part, and one updatable writeonly part:
```golang
type MeterSnapshot interface {
Count() int64
Rate1() float64
Rate5() float64
Rate15() float64
RateMean() float64
}
// Meters count events to produce exponentially-weighted moving average rates
// at one-, five-, and fifteen-minutes and a mean rate.
type Meter interface {
Mark(int64)
Snapshot() MeterSnapshot
Stop()
}
```
### A note about concurrency
This PR makes the concurrency model clearer. We have actual meters and snapshot of meters. The `meter` is the thing which can be accessed from the registry, and updates can be made to it.
- For all `meters`, (`Gauge`, `Timer` etc), it is assumed that they are accessed by different threads, making updates. Therefore, all `meters` update-methods (`Inc`, `Add`, `Update`, `Clear` etc) need to be concurrency-safe.
- All `meters` have a `Snapshot()` method. This method is _usually_ called from one thread, a backend-exporter. But it's fully possible to have several exporters simultaneously: therefore this method should also be concurrency-safe.
TLDR: `meter`s are accessible via registry, all their methods must be concurrency-safe.
For all `Snapshot`s, it is assumed that an individual exporter-thread has obtained a `meter` from the registry, and called the `Snapshot` method to obtain a readonly snapshot. This snapshot is _not_ guaranteed to be concurrency-safe. There's no need for a snapshot to be concurrency-safe, since exporters should not share snapshots.
Note, though: that by happenstance a lot of the snapshots _are_ concurrency-safe, being unmutable minimal representations of a value. Only the more complex ones are _not_ threadsafe, those that lazily calculate things like `Variance()`, `Mean()`.
Example of how a background exporter typically works, obtaining the snapshot and sequentially accessing the non-threadsafe methods in it:
```golang
ms := metric.Snapshot()
...
fields := map[string]interface{}{
"count": ms.Count(),
"max": ms.Max(),
"mean": ms.Mean(),
"min": ms.Min(),
"stddev": ms.StdDev(),
"variance": ms.Variance(),
```
TLDR: `snapshots` are not guaranteed to be concurrency-safe (but often are).
### Sample changes
I also changed the `Sample` type: previously, it iterated the samples fully every time `Mean()`,`Sum()`, `Min()` or `Max()` was invoked. Since we now have readonly base data, we can just iterate it once, in the constructor, and set all four values at once.
The same thing has been done for runtimehistogram.
### ResettingTimer API
Back when ResettingTImer was implemented, as part of https://github.com/ethereum/go-ethereum/pull/15910, Anton implemented a `Percentiles` on the new type. However, the method did not conform to the other existing types which also had a `Percentiles`.
1. The existing ones, on input, took `0.5` to mean `50%`. Anton used `50` to mean `50%`.
2. The existing ones returned `float64` outputs, thus interpolating between values. A value-set of `0, 10`, at `50%` would return `5`, whereas Anton's would return either `0` or `10`.
This PR removes the 'new' version, and uses only the 'legacy' percentiles, also for the ResettingTimer type.
The resetting timer snapshot was also defined so that it would expose the internal values. This has been removed, and getters for `Max, Min, Mean` have been added instead.
### Unexport types
A lot of types were exported, but do not need to be. This PR unexports quite a lot of them.
113 lines
3.0 KiB
Go
113 lines
3.0 KiB
Go
package metrics
|
|
|
|
import (
|
|
"sync/atomic"
|
|
)
|
|
|
|
type CounterSnapshot interface {
|
|
Count() int64
|
|
}
|
|
|
|
// Counters hold an int64 value that can be incremented and decremented.
|
|
type Counter interface {
|
|
Clear()
|
|
Dec(int64)
|
|
Inc(int64)
|
|
Snapshot() CounterSnapshot
|
|
}
|
|
|
|
// GetOrRegisterCounter returns an existing Counter or constructs and registers
|
|
// a new StandardCounter.
|
|
func GetOrRegisterCounter(name string, r Registry) Counter {
|
|
if nil == r {
|
|
r = DefaultRegistry
|
|
}
|
|
return r.GetOrRegister(name, NewCounter).(Counter)
|
|
}
|
|
|
|
// GetOrRegisterCounterForced returns an existing Counter or constructs and registers a
|
|
// new Counter no matter the global switch is enabled or not.
|
|
// Be sure to unregister the counter from the registry once it is of no use to
|
|
// allow for garbage collection.
|
|
func GetOrRegisterCounterForced(name string, r Registry) Counter {
|
|
if nil == r {
|
|
r = DefaultRegistry
|
|
}
|
|
return r.GetOrRegister(name, NewCounterForced).(Counter)
|
|
}
|
|
|
|
// NewCounter constructs a new StandardCounter.
|
|
func NewCounter() Counter {
|
|
if !Enabled {
|
|
return NilCounter{}
|
|
}
|
|
return new(StandardCounter)
|
|
}
|
|
|
|
// NewCounterForced constructs a new StandardCounter and returns it no matter if
|
|
// the global switch is enabled or not.
|
|
func NewCounterForced() Counter {
|
|
return new(StandardCounter)
|
|
}
|
|
|
|
// NewRegisteredCounter constructs and registers a new StandardCounter.
|
|
func NewRegisteredCounter(name string, r Registry) Counter {
|
|
c := NewCounter()
|
|
if nil == r {
|
|
r = DefaultRegistry
|
|
}
|
|
r.Register(name, c)
|
|
return c
|
|
}
|
|
|
|
// NewRegisteredCounterForced constructs and registers a new StandardCounter
|
|
// and launches a goroutine no matter the global switch is enabled or not.
|
|
// Be sure to unregister the counter from the registry once it is of no use to
|
|
// allow for garbage collection.
|
|
func NewRegisteredCounterForced(name string, r Registry) Counter {
|
|
c := NewCounterForced()
|
|
if nil == r {
|
|
r = DefaultRegistry
|
|
}
|
|
r.Register(name, c)
|
|
return c
|
|
}
|
|
|
|
// counterSnapshot is a read-only copy of another Counter.
|
|
type counterSnapshot int64
|
|
|
|
// Count returns the count at the time the snapshot was taken.
|
|
func (c counterSnapshot) Count() int64 { return int64(c) }
|
|
|
|
// NilCounter is a no-op Counter.
|
|
type NilCounter struct{}
|
|
|
|
func (NilCounter) Clear() {}
|
|
func (NilCounter) Dec(i int64) {}
|
|
func (NilCounter) Inc(i int64) {}
|
|
func (NilCounter) Snapshot() CounterSnapshot { return (*emptySnapshot)(nil) }
|
|
|
|
// StandardCounter is the standard implementation of a Counter and uses the
|
|
// sync/atomic package to manage a single int64 value.
|
|
type StandardCounter atomic.Int64
|
|
|
|
// Clear sets the counter to zero.
|
|
func (c *StandardCounter) Clear() {
|
|
(*atomic.Int64)(c).Store(0)
|
|
}
|
|
|
|
// Dec decrements the counter by the given amount.
|
|
func (c *StandardCounter) Dec(i int64) {
|
|
(*atomic.Int64)(c).Add(-i)
|
|
}
|
|
|
|
// Inc increments the counter by the given amount.
|
|
func (c *StandardCounter) Inc(i int64) {
|
|
(*atomic.Int64)(c).Add(i)
|
|
}
|
|
|
|
// Snapshot returns a read-only copy of the counter.
|
|
func (c *StandardCounter) Snapshot() CounterSnapshot {
|
|
return counterSnapshot((*atomic.Int64)(c).Load())
|
|
}
|