mirror of
https://github.com/docker/cli.git
synced 2026-08-28 10:05:17 -05:00
Sebastiaan van Stijn
3cd22ff935
- Add support for creating timers with custom histogram buckets. - Update `github.com/prometheus/client_golang` to v1.20.5. - Update the minimum supported Go version to Go 1.21. - Improve HTTP handler instrumentation, including minor performance improvements and cleanup. - Avoid mutating shared label maps when creating namespaces and metrics. - Encapsulate the Prometheus collector used by `HTTPMetric`. - Improve package and API documentation. - Update `golang.org/x/sys` and other dependencies. full diff: https://github.com/docker/go-metrics/compare/v0.0.1...v0.1.0 Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
90 lines
2.4 KiB
Go
90 lines
2.4 KiB
Go
package metrics
|
|
|
|
import (
|
|
"time"
|
|
|
|
"github.com/prometheus/client_golang/prometheus"
|
|
)
|
|
|
|
// StartTimer begins a timer observation at the callsite. When the target
|
|
// operation is completed, the caller should call the return done func().
|
|
func StartTimer(timer Timer) (done func()) {
|
|
start := time.Now()
|
|
return func() {
|
|
timer.Update(time.Since(start))
|
|
}
|
|
}
|
|
|
|
// Timer is a metric that allows collecting the duration of an action in seconds
|
|
type Timer interface {
|
|
// Update records an observation, duration, and converts to the target
|
|
// units.
|
|
Update(duration time.Duration)
|
|
|
|
// UpdateSince will add the duration from the provided starting time to the
|
|
// timer's summary with the precisions that was used in creation of the timer
|
|
UpdateSince(time.Time)
|
|
}
|
|
|
|
// LabeledTimer is a timer that must have label values populated before use.
|
|
type LabeledTimer interface {
|
|
WithValues(labels ...string) *labeledTimerObserver
|
|
}
|
|
|
|
type labeledTimer struct {
|
|
m *prometheus.HistogramVec
|
|
}
|
|
|
|
type labeledTimerObserver struct {
|
|
m prometheus.Observer
|
|
}
|
|
|
|
func (lbo *labeledTimerObserver) Update(duration time.Duration) {
|
|
lbo.m.Observe(duration.Seconds())
|
|
}
|
|
|
|
func (lbo *labeledTimerObserver) UpdateSince(since time.Time) {
|
|
lbo.m.Observe(time.Since(since).Seconds())
|
|
}
|
|
|
|
func (lt *labeledTimer) WithValues(labels ...string) *labeledTimerObserver {
|
|
return &labeledTimerObserver{m: lt.m.WithLabelValues(labels...)}
|
|
}
|
|
|
|
// Describe implements [prometheus.Collector].
|
|
func (lt *labeledTimer) Describe(c chan<- *prometheus.Desc) {
|
|
lt.m.Describe(c)
|
|
}
|
|
|
|
// Collect implements [prometheus.Collector].
|
|
func (lt *labeledTimer) Collect(c chan<- prometheus.Metric) {
|
|
lt.m.Collect(c)
|
|
}
|
|
|
|
type timer struct {
|
|
m prometheus.Observer
|
|
}
|
|
|
|
func (t *timer) Update(duration time.Duration) {
|
|
t.m.Observe(duration.Seconds())
|
|
}
|
|
|
|
func (t *timer) UpdateSince(since time.Time) {
|
|
t.m.Observe(time.Since(since).Seconds())
|
|
}
|
|
|
|
// Describe implements [prometheus.Collector].
|
|
func (t *timer) Describe(c chan<- *prometheus.Desc) {
|
|
c <- t.m.(prometheus.Metric).Desc()
|
|
}
|
|
|
|
// Collect implements [prometheus.Collector].
|
|
func (t *timer) Collect(c chan<- prometheus.Metric) {
|
|
// Are there any observers that don't implement Collector? It is really
|
|
// unclear what the point of the upstream change was, but we'll let this
|
|
// panic if we get an observer that doesn't implement collector. In this
|
|
// case, we should almost always see metricVec objects, so this should
|
|
// never panic.
|
|
t.m.(prometheus.Collector).Collect(c)
|
|
}
|