68691d7775
Because Summary metrics can not be aggreated, convert them to histograms so that users with HA deployments can use these metrics. * Convert metrics registration to promauto. * Improve help text style. Signed-off-by: SuperQ <superq@gmail.com>
63 lines
2.0 KiB
Go
63 lines
2.0 KiB
Go
// Package instrumentation contains backend plugin instrumentation logic.
|
|
package instrumentation
|
|
|
|
import (
|
|
"time"
|
|
|
|
"github.com/prometheus/client_golang/prometheus"
|
|
"github.com/prometheus/client_golang/prometheus/promauto"
|
|
)
|
|
|
|
var (
|
|
pluginRequestCounter = promauto.NewCounterVec(prometheus.CounterOpts{
|
|
Namespace: "grafana",
|
|
Name: "plugin_request_total",
|
|
Help: "The total amount of plugin requests",
|
|
}, []string{"plugin_id", "endpoint", "status"})
|
|
|
|
pluginRequestDuration = promauto.NewHistogramVec(prometheus.HistogramOpts{
|
|
Namespace: "grafana",
|
|
Name: "plugin_request_duration_milliseconds",
|
|
Help: "Plugin request duration",
|
|
Buckets: []float64{.005, .01, .025, .05, .1, .25, .5, 1, 2.5, 5, 10, 25, 50, 100},
|
|
}, []string{"plugin_id", "endpoint"})
|
|
)
|
|
|
|
// instrumentPluginRequest instruments success rate and latency of `fn`
|
|
func instrumentPluginRequest(pluginID string, endpoint string, fn func() error) error {
|
|
status := "ok"
|
|
|
|
start := time.Now()
|
|
|
|
err := fn()
|
|
if err != nil {
|
|
status = "error"
|
|
}
|
|
|
|
elapsed := time.Since(start) / time.Millisecond
|
|
pluginRequestDuration.WithLabelValues(pluginID, endpoint).Observe(float64(elapsed))
|
|
pluginRequestCounter.WithLabelValues(pluginID, endpoint, status).Inc()
|
|
|
|
return err
|
|
}
|
|
|
|
// InstrumentCollectMetrics instruments collectMetrics.
|
|
func InstrumentCollectMetrics(pluginID string, fn func() error) error {
|
|
return instrumentPluginRequest(pluginID, "collectMetrics", fn)
|
|
}
|
|
|
|
// InstrumentCheckHealthRequest instruments checkHealth.
|
|
func InstrumentCheckHealthRequest(pluginID string, fn func() error) error {
|
|
return instrumentPluginRequest(pluginID, "checkHealth", fn)
|
|
}
|
|
|
|
// InstrumentCallResourceRequest instruments callResource.
|
|
func InstrumentCallResourceRequest(pluginID string, fn func() error) error {
|
|
return instrumentPluginRequest(pluginID, "callResource", fn)
|
|
}
|
|
|
|
// InstrumentQueryDataRequest instruments success rate and latency of query data requests.
|
|
func InstrumentQueryDataRequest(pluginID string, fn func() error) error {
|
|
return instrumentPluginRequest(pluginID, "queryData", fn)
|
|
}
|