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>
69 lines
2.1 KiB
Go
69 lines
2.1 KiB
Go
package metrics
|
|
|
|
import (
|
|
"net/http"
|
|
|
|
"github.com/prometheus/client_golang/prometheus"
|
|
"github.com/prometheus/client_golang/prometheus/promhttp"
|
|
)
|
|
|
|
// HTTPHandlerOpts configures HTTP instrumentation metrics.
|
|
type HTTPHandlerOpts struct {
|
|
DurationBuckets []float64
|
|
RequestSizeBuckets []float64
|
|
ResponseSizeBuckets []float64
|
|
}
|
|
|
|
// HTTPMetric describes a metric used to instrument an HTTP handler.
|
|
//
|
|
// HTTPMetric values must be created using the HTTP metric methods on
|
|
// [Namespace], such as [Namespace.NewDefaultHttpMetrics] or
|
|
// [Namespace.NewHttpMetricsWithOpts].
|
|
type HTTPMetric struct {
|
|
collector prometheus.Collector
|
|
wrap func(http.Handler) http.Handler
|
|
}
|
|
|
|
var _ prometheus.Collector = (*HTTPMetric)(nil)
|
|
|
|
// Describe implements [prometheus.Collector].
|
|
func (m *HTTPMetric) Describe(ch chan<- *prometheus.Desc) {
|
|
m.collector.Describe(ch)
|
|
}
|
|
|
|
// Collect implements [prometheus.Collector].
|
|
func (m *HTTPMetric) Collect(ch chan<- prometheus.Metric) {
|
|
m.collector.Collect(ch)
|
|
}
|
|
|
|
var (
|
|
defaultDurationBuckets = []float64{.005, .01, .025, .05, .1, .25, .5, 1, 2.5, 5, 10, 25, 60}
|
|
defaultRequestSizeBuckets = prometheus.ExponentialBuckets(1024, 2, 22) // 1K to 4G
|
|
defaultResponseSizeBuckets = defaultRequestSizeBuckets
|
|
)
|
|
|
|
// Handler is a convenience wrapper around [promhttp.Handler] that returns an
|
|
// HTTP handler serving metrics from the default Prometheus gatherer.
|
|
func Handler() http.Handler {
|
|
return promhttp.Handler()
|
|
}
|
|
|
|
// InstrumentHandler returns an HTTP handler function that instruments handler
|
|
// with the provided HTTP metrics.
|
|
func InstrumentHandler(metrics []*HTTPMetric, handler http.Handler) http.HandlerFunc {
|
|
return instrumentHandler(metrics, handler)
|
|
}
|
|
|
|
// InstrumentHandlerFunc returns an HTTP handler function that instruments
|
|
// handlerFunc with the provided HTTP metrics.
|
|
func InstrumentHandlerFunc(metrics []*HTTPMetric, handlerFunc http.HandlerFunc) http.HandlerFunc {
|
|
return instrumentHandler(metrics, handlerFunc)
|
|
}
|
|
|
|
func instrumentHandler(metrics []*HTTPMetric, handler http.Handler) http.HandlerFunc {
|
|
for _, metric := range metrics {
|
|
handler = metric.wrap(handler)
|
|
}
|
|
return handler.ServeHTTP
|
|
}
|