mirror of
https://github.com/grafana/grafana.git
synced 2025-02-20 11:48:34 -06:00
c0f3b2929c
Refactor to allow shared contract between core and external backend plugins allowing core backend data sources in Grafana to be implemented in same way as an external backend plugin. Use v0.67.0 of sdk. Add tests for verifying plugin is restarted when process is killed. Enable strict linting for backendplugin packages
88 lines
2.8 KiB
Go
88 lines
2.8 KiB
Go
package backendplugin
|
|
|
|
import (
|
|
"context"
|
|
"time"
|
|
|
|
"github.com/grafana/grafana-plugin-sdk-go/backend"
|
|
"github.com/prometheus/client_golang/prometheus"
|
|
)
|
|
|
|
var (
|
|
pluginRequestCounter *prometheus.CounterVec
|
|
pluginRequestDuration *prometheus.SummaryVec
|
|
)
|
|
|
|
func init() {
|
|
pluginRequestCounter = prometheus.NewCounterVec(prometheus.CounterOpts{
|
|
Namespace: "grafana",
|
|
Name: "plugin_request_total",
|
|
Help: "The total amount of plugin requests",
|
|
}, []string{"plugin_id", "endpoint", "status"})
|
|
|
|
pluginRequestDuration = prometheus.NewSummaryVec(prometheus.SummaryOpts{
|
|
Namespace: "grafana",
|
|
Name: "plugin_request_duration_milliseconds",
|
|
Help: "Plugin request duration",
|
|
Objectives: map[float64]float64{0.5: 0.05, 0.9: 0.01, 0.99: 0.001},
|
|
}, []string{"plugin_id", "endpoint"})
|
|
|
|
prometheus.MustRegister(pluginRequestCounter, pluginRequestDuration)
|
|
}
|
|
|
|
// 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
|
|
}
|
|
|
|
func instrumentCollectMetrics(pluginID string, fn func() error) error {
|
|
return instrumentPluginRequest(pluginID, "collectMetrics", fn)
|
|
}
|
|
|
|
func instrumentCheckHealthRequest(pluginID string, fn func() error) error {
|
|
return instrumentPluginRequest(pluginID, "checkHealth", fn)
|
|
}
|
|
|
|
func instrumentCallResourceRequest(pluginID string, fn func() error) error {
|
|
return instrumentPluginRequest(pluginID, "callResource", fn)
|
|
}
|
|
|
|
// InstrumentQueryDataRequest instruments success rate and latency of query data request.
|
|
func InstrumentQueryDataRequest(pluginID string, fn func() error) error {
|
|
return instrumentPluginRequest(pluginID, "queryData", fn)
|
|
}
|
|
|
|
// InstrumentTransformDataRequest instruments success rate and latency of transform data request.
|
|
func InstrumentTransformDataRequest(pluginID string, fn func() error) error {
|
|
return instrumentPluginRequest(pluginID, "transformData", fn)
|
|
}
|
|
|
|
// InstrumentQueryDataHandler wraps a backend.QueryDataHandler with instrumentation of success rate and latency.
|
|
func InstrumentQueryDataHandler(handler backend.QueryDataHandler) backend.QueryDataHandler {
|
|
if handler == nil {
|
|
return nil
|
|
}
|
|
|
|
return backend.QueryDataHandlerFunc(func(ctx context.Context, req *backend.QueryDataRequest) (*backend.QueryDataResponse, error) {
|
|
var resp *backend.QueryDataResponse
|
|
err := InstrumentQueryDataRequest(req.PluginContext.PluginID, func() (innerErr error) {
|
|
resp, innerErr = handler.QueryData(ctx, req)
|
|
return
|
|
})
|
|
return resp, err
|
|
})
|
|
}
|