mirror of
https://github.com/grafana/grafana.git
synced 2025-02-25 18:55:37 -06:00
212 lines
9.2 KiB
Go
212 lines
9.2 KiB
Go
package clientmiddleware
|
|
|
|
import (
|
|
"context"
|
|
"time"
|
|
|
|
"github.com/grafana/grafana-plugin-sdk-go/backend"
|
|
"github.com/prometheus/client_golang/prometheus"
|
|
|
|
"github.com/grafana/grafana/pkg/infra/tracing"
|
|
"github.com/grafana/grafana/pkg/plugins"
|
|
"github.com/grafana/grafana/pkg/plugins/manager/registry"
|
|
"github.com/grafana/grafana/pkg/plugins/pluginrequestmeta"
|
|
"github.com/grafana/grafana/pkg/services/featuremgmt"
|
|
)
|
|
|
|
// pluginMetrics contains the prometheus metrics used by the MetricsMiddleware.
|
|
type pluginMetrics struct {
|
|
pluginRequestCounter *prometheus.CounterVec
|
|
pluginRequestDuration *prometheus.HistogramVec
|
|
pluginRequestSize *prometheus.HistogramVec
|
|
pluginRequestDurationSeconds *prometheus.HistogramVec
|
|
}
|
|
|
|
// MetricsMiddleware is a middleware that instruments plugin requests.
|
|
// It tracks requests count, duration and size as prometheus metrics.
|
|
type MetricsMiddleware struct {
|
|
pluginMetrics
|
|
pluginRegistry registry.Service
|
|
features featuremgmt.FeatureToggles
|
|
next plugins.Client
|
|
}
|
|
|
|
func newMetricsMiddleware(promRegisterer prometheus.Registerer, pluginRegistry registry.Service, features featuremgmt.FeatureToggles) *MetricsMiddleware {
|
|
var additionalLabels []string
|
|
if features.IsEnabledGlobally(featuremgmt.FlagPluginsInstrumentationStatusSource) {
|
|
additionalLabels = []string{"status_source"}
|
|
}
|
|
pluginRequestCounter := prometheus.NewCounterVec(prometheus.CounterOpts{
|
|
Namespace: "grafana",
|
|
Name: "plugin_request_total",
|
|
Help: "The total amount of plugin requests",
|
|
}, append([]string{"plugin_id", "endpoint", "status", "target"}, additionalLabels...))
|
|
pluginRequestDuration := prometheus.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},
|
|
}, append([]string{"plugin_id", "endpoint", "target"}, additionalLabels...))
|
|
pluginRequestSize := prometheus.NewHistogramVec(
|
|
prometheus.HistogramOpts{
|
|
Namespace: "grafana",
|
|
Name: "plugin_request_size_bytes",
|
|
Help: "histogram of plugin request sizes returned",
|
|
Buckets: []float64{128, 256, 512, 1024, 2048, 4096, 8192, 16384, 32768, 65536, 131072, 262144, 524288, 1048576},
|
|
}, []string{"source", "plugin_id", "endpoint", "target"},
|
|
)
|
|
pluginRequestDurationSeconds := prometheus.NewHistogramVec(prometheus.HistogramOpts{
|
|
Namespace: "grafana",
|
|
Name: "plugin_request_duration_seconds",
|
|
Help: "Plugin request duration in seconds",
|
|
Buckets: []float64{.005, .01, .025, .05, .1, .25, .5, 1, 2.5, 5, 10, 25},
|
|
}, append([]string{"source", "plugin_id", "endpoint", "status", "target"}, additionalLabels...))
|
|
promRegisterer.MustRegister(
|
|
pluginRequestCounter,
|
|
pluginRequestDuration,
|
|
pluginRequestSize,
|
|
pluginRequestDurationSeconds,
|
|
)
|
|
return &MetricsMiddleware{
|
|
pluginMetrics: pluginMetrics{
|
|
pluginRequestCounter: pluginRequestCounter,
|
|
pluginRequestDuration: pluginRequestDuration,
|
|
pluginRequestSize: pluginRequestSize,
|
|
pluginRequestDurationSeconds: pluginRequestDurationSeconds,
|
|
},
|
|
pluginRegistry: pluginRegistry,
|
|
features: features,
|
|
}
|
|
}
|
|
|
|
// NewMetricsMiddleware returns a new MetricsMiddleware.
|
|
func NewMetricsMiddleware(promRegisterer prometheus.Registerer, pluginRegistry registry.Service, features featuremgmt.FeatureToggles) plugins.ClientMiddleware {
|
|
imw := newMetricsMiddleware(promRegisterer, pluginRegistry, features)
|
|
return plugins.ClientMiddlewareFunc(func(next plugins.Client) plugins.Client {
|
|
imw.next = next
|
|
return imw
|
|
})
|
|
}
|
|
|
|
// pluginTarget returns the value for the "target" Prometheus label for the given plugin ID.
|
|
func (m *MetricsMiddleware) pluginTarget(ctx context.Context, pluginID string) (string, error) {
|
|
p, exists := m.pluginRegistry.Plugin(ctx, pluginID)
|
|
if !exists {
|
|
return "", plugins.ErrPluginNotRegistered
|
|
}
|
|
return string(p.Target()), nil
|
|
}
|
|
|
|
// instrumentPluginRequestSize tracks the size of the given request in the m.pluginRequestSize metric.
|
|
func (m *MetricsMiddleware) instrumentPluginRequestSize(ctx context.Context, pluginCtx backend.PluginContext, endpoint string, requestSize float64) error {
|
|
target, err := m.pluginTarget(ctx, pluginCtx.PluginID)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
m.pluginRequestSize.WithLabelValues("grafana-backend", pluginCtx.PluginID, endpoint, target).Observe(requestSize)
|
|
return nil
|
|
}
|
|
|
|
// instrumentPluginRequest increments the m.pluginRequestCounter metric and tracks the duration of the given request.
|
|
func (m *MetricsMiddleware) instrumentPluginRequest(ctx context.Context, pluginCtx backend.PluginContext, endpoint string, fn func(context.Context) (requestStatus, error)) error {
|
|
target, err := m.pluginTarget(ctx, pluginCtx.PluginID)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
|
|
start := time.Now()
|
|
|
|
status, err := fn(ctx)
|
|
elapsed := time.Since(start)
|
|
|
|
pluginRequestDurationLabels := []string{pluginCtx.PluginID, endpoint, target}
|
|
pluginRequestCounterLabels := []string{pluginCtx.PluginID, endpoint, status.String(), target}
|
|
pluginRequestDurationSecondsLabels := []string{"grafana-backend", pluginCtx.PluginID, endpoint, status.String(), target}
|
|
if m.features.IsEnabled(ctx, featuremgmt.FlagPluginsInstrumentationStatusSource) {
|
|
statusSource := pluginrequestmeta.StatusSourceFromContext(ctx)
|
|
pluginRequestDurationLabels = append(pluginRequestDurationLabels, string(statusSource))
|
|
pluginRequestCounterLabels = append(pluginRequestCounterLabels, string(statusSource))
|
|
pluginRequestDurationSecondsLabels = append(pluginRequestDurationSecondsLabels, string(statusSource))
|
|
}
|
|
|
|
pluginRequestDurationWithLabels := m.pluginRequestDuration.WithLabelValues(pluginRequestDurationLabels...)
|
|
pluginRequestCounterWithLabels := m.pluginRequestCounter.WithLabelValues(pluginRequestCounterLabels...)
|
|
pluginRequestDurationSecondsWithLabels := m.pluginRequestDurationSeconds.WithLabelValues(pluginRequestDurationSecondsLabels...)
|
|
|
|
if traceID := tracing.TraceIDFromContext(ctx, true); traceID != "" {
|
|
pluginRequestDurationWithLabels.(prometheus.ExemplarObserver).ObserveWithExemplar(
|
|
float64(elapsed/time.Millisecond), prometheus.Labels{"traceID": traceID},
|
|
)
|
|
pluginRequestCounterWithLabels.(prometheus.ExemplarAdder).AddWithExemplar(1, prometheus.Labels{"traceID": traceID})
|
|
pluginRequestDurationSecondsWithLabels.(prometheus.ExemplarObserver).ObserveWithExemplar(
|
|
elapsed.Seconds(), prometheus.Labels{"traceID": traceID},
|
|
)
|
|
} else {
|
|
pluginRequestDurationWithLabels.Observe(float64(elapsed / time.Millisecond))
|
|
pluginRequestCounterWithLabels.Inc()
|
|
pluginRequestDurationSecondsWithLabels.Observe(elapsed.Seconds())
|
|
}
|
|
|
|
return err
|
|
}
|
|
|
|
func (m *MetricsMiddleware) QueryData(ctx context.Context, req *backend.QueryDataRequest) (*backend.QueryDataResponse, error) {
|
|
var requestSize float64
|
|
for _, v := range req.Queries {
|
|
requestSize += float64(len(v.JSON))
|
|
}
|
|
|
|
if err := m.instrumentPluginRequestSize(ctx, req.PluginContext, endpointQueryData, requestSize); err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
var resp *backend.QueryDataResponse
|
|
err := m.instrumentPluginRequest(ctx, req.PluginContext, endpointQueryData, func(ctx context.Context) (status requestStatus, innerErr error) {
|
|
resp, innerErr = m.next.QueryData(ctx, req)
|
|
return requestStatusFromQueryDataResponse(resp, innerErr), innerErr
|
|
})
|
|
|
|
return resp, err
|
|
}
|
|
|
|
func (m *MetricsMiddleware) CallResource(ctx context.Context, req *backend.CallResourceRequest, sender backend.CallResourceResponseSender) error {
|
|
if err := m.instrumentPluginRequestSize(ctx, req.PluginContext, endpointCallResource, float64(len(req.Body))); err != nil {
|
|
return err
|
|
}
|
|
return m.instrumentPluginRequest(ctx, req.PluginContext, endpointCallResource, func(ctx context.Context) (requestStatus, error) {
|
|
innerErr := m.next.CallResource(ctx, req, sender)
|
|
return requestStatusFromError(innerErr), innerErr
|
|
})
|
|
}
|
|
|
|
func (m *MetricsMiddleware) CheckHealth(ctx context.Context, req *backend.CheckHealthRequest) (*backend.CheckHealthResult, error) {
|
|
var result *backend.CheckHealthResult
|
|
err := m.instrumentPluginRequest(ctx, req.PluginContext, endpointCheckHealth, func(ctx context.Context) (status requestStatus, innerErr error) {
|
|
result, innerErr = m.next.CheckHealth(ctx, req)
|
|
return requestStatusFromError(innerErr), innerErr
|
|
})
|
|
|
|
return result, err
|
|
}
|
|
|
|
func (m *MetricsMiddleware) CollectMetrics(ctx context.Context, req *backend.CollectMetricsRequest) (*backend.CollectMetricsResult, error) {
|
|
var result *backend.CollectMetricsResult
|
|
err := m.instrumentPluginRequest(ctx, req.PluginContext, endpointCollectMetrics, func(ctx context.Context) (status requestStatus, innerErr error) {
|
|
result, innerErr = m.next.CollectMetrics(ctx, req)
|
|
return requestStatusFromError(innerErr), innerErr
|
|
})
|
|
return result, err
|
|
}
|
|
|
|
func (m *MetricsMiddleware) SubscribeStream(ctx context.Context, req *backend.SubscribeStreamRequest) (*backend.SubscribeStreamResponse, error) {
|
|
return m.next.SubscribeStream(ctx, req)
|
|
}
|
|
|
|
func (m *MetricsMiddleware) PublishStream(ctx context.Context, req *backend.PublishStreamRequest) (*backend.PublishStreamResponse, error) {
|
|
return m.next.PublishStream(ctx, req)
|
|
}
|
|
|
|
func (m *MetricsMiddleware) RunStream(ctx context.Context, req *backend.RunStreamRequest, sender *backend.StreamSender) error {
|
|
return m.next.RunStream(ctx, req, sender)
|
|
}
|