mirror of
https://github.com/grafana/grafana.git
synced 2026-08-11 05:34:53 -05:00
Plugins: Refactor instrumentation to logger middleware (#74726)
This commit is contained in:
@@ -13,7 +13,6 @@ import (
|
||||
"github.com/grafana/grafana/pkg/infra/log"
|
||||
"github.com/grafana/grafana/pkg/infra/tracing"
|
||||
"github.com/grafana/grafana/pkg/plugins/backendplugin"
|
||||
plog "github.com/grafana/grafana/pkg/plugins/log"
|
||||
)
|
||||
|
||||
var (
|
||||
@@ -58,14 +57,10 @@ const (
|
||||
endpointQueryData = "queryData"
|
||||
)
|
||||
|
||||
var logger = plog.New("plugin.instrumentation")
|
||||
|
||||
// instrumentPluginRequest instruments success rate and latency of `fn`
|
||||
func instrumentPluginRequest(ctx context.Context, cfg Cfg, pluginCtx *backend.PluginContext, endpoint string, fn func(ctx context.Context) error) error {
|
||||
status := statusOK
|
||||
|
||||
start := time.Now()
|
||||
timeBeforePluginRequest := log.TimeSinceStart(ctx, start)
|
||||
|
||||
ctx = instrumentContext(ctx, endpoint, *pluginCtx)
|
||||
err := fn(ctx)
|
||||
@@ -96,37 +91,6 @@ func instrumentPluginRequest(ctx context.Context, cfg Cfg, pluginCtx *backend.Pl
|
||||
pluginRequestDurationSecondsWithLabels.Observe(elapsed.Seconds())
|
||||
}
|
||||
|
||||
if cfg.LogDatasourceRequests {
|
||||
logParams := []any{
|
||||
"status", status,
|
||||
"duration", elapsed,
|
||||
"pluginId", pluginCtx.PluginID,
|
||||
"endpoint", endpoint,
|
||||
"eventName", "grafana-data-egress",
|
||||
"time_before_plugin_request", timeBeforePluginRequest,
|
||||
}
|
||||
|
||||
if pluginCtx.User != nil {
|
||||
logParams = append(logParams, "uname", pluginCtx.User.Login)
|
||||
}
|
||||
|
||||
traceID := tracing.TraceIDFromContext(ctx, false)
|
||||
if traceID != "" {
|
||||
logParams = append(logParams, "traceID", traceID)
|
||||
}
|
||||
|
||||
if pluginCtx.DataSourceInstanceSettings != nil {
|
||||
logParams = append(logParams, "dsName", pluginCtx.DataSourceInstanceSettings.Name)
|
||||
logParams = append(logParams, "dsUID", pluginCtx.DataSourceInstanceSettings.UID)
|
||||
}
|
||||
|
||||
if status == statusError {
|
||||
logParams = append(logParams, "error", err)
|
||||
}
|
||||
|
||||
logger.Info("Plugin Request Completed", logParams...)
|
||||
}
|
||||
|
||||
return err
|
||||
}
|
||||
|
||||
@@ -140,8 +104,7 @@ func instrumentContext(ctx context.Context, endpoint string, pCtx backend.Plugin
|
||||
}
|
||||
|
||||
type Cfg struct {
|
||||
LogDatasourceRequests bool
|
||||
Target backendplugin.Target
|
||||
Target backendplugin.Target
|
||||
}
|
||||
|
||||
// InstrumentCollectMetrics instruments collectMetrics.
|
||||
|
||||
@@ -58,8 +58,7 @@ func (s *Service) QueryData(ctx context.Context, req *backend.QueryDataRequest)
|
||||
|
||||
var resp *backend.QueryDataResponse
|
||||
err := instrumentation.InstrumentQueryDataRequest(ctx, &req.PluginContext, instrumentation.Cfg{
|
||||
LogDatasourceRequests: s.cfg.LogDatasourceRequests,
|
||||
Target: p.Target(),
|
||||
Target: p.Target(),
|
||||
}, totalBytes, func(ctx context.Context) (innerErr error) {
|
||||
resp, innerErr = p.QueryData(ctx, req)
|
||||
return
|
||||
@@ -105,8 +104,7 @@ func (s *Service) CallResource(ctx context.Context, req *backend.CallResourceReq
|
||||
|
||||
totalBytes := float64(len(req.Body))
|
||||
err := instrumentation.InstrumentCallResourceRequest(ctx, &req.PluginContext, instrumentation.Cfg{
|
||||
LogDatasourceRequests: s.cfg.LogDatasourceRequests,
|
||||
Target: p.Target(),
|
||||
Target: p.Target(),
|
||||
}, totalBytes, func(ctx context.Context) (innerErr error) {
|
||||
removeConnectionHeaders(req.Headers)
|
||||
removeHopByHopHeaders(req.Headers)
|
||||
@@ -152,8 +150,7 @@ func (s *Service) CollectMetrics(ctx context.Context, req *backend.CollectMetric
|
||||
|
||||
var resp *backend.CollectMetricsResult
|
||||
err := instrumentation.InstrumentCollectMetrics(ctx, &req.PluginContext, instrumentation.Cfg{
|
||||
LogDatasourceRequests: s.cfg.LogDatasourceRequests,
|
||||
Target: p.Target(),
|
||||
Target: p.Target(),
|
||||
}, func(ctx context.Context) (innerErr error) {
|
||||
resp, innerErr = p.CollectMetrics(ctx, req)
|
||||
return
|
||||
@@ -177,8 +174,7 @@ func (s *Service) CheckHealth(ctx context.Context, req *backend.CheckHealthReque
|
||||
|
||||
var resp *backend.CheckHealthResult
|
||||
err := instrumentation.InstrumentCheckHealthRequest(ctx, &req.PluginContext, instrumentation.Cfg{
|
||||
LogDatasourceRequests: s.cfg.LogDatasourceRequests,
|
||||
Target: p.Target(),
|
||||
Target: p.Target(),
|
||||
}, func(ctx context.Context) (innerErr error) {
|
||||
resp, innerErr = p.CheckHealth(ctx, req)
|
||||
return
|
||||
|
||||
Reference in New Issue
Block a user