opensource/grafana
1
0
Fork 0
mirror of https://github.com/grafana/grafana.git synced 2025-08-02 15:52:29 +08:00
Code Issues Packages Projects Releases Wiki Activity

Plugin Instrumentation: Add target property to request logs (#91946)

Browse Source 
* Plugin Instrumentation: Add `target` property to request logs

* remove comment

* remove error
This commit is contained in:
Sven Grossmann
2024-09-02 17:41:26 +02:00
committed by GitHub
parent 564d09c9be
commit 5ad7c47816
2 changed files with 27 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files

40
pkg/services/pluginsintegration/clientmiddleware/logger_middleware.go
View File

@ -10,28 +10,39 @@ import (
"github.com/grafana/grafana/pkg/plugins" "github.com/grafana/grafana/pkg/plugins"
"github.com/grafana/grafana/pkg/plugins/instrumentationutils" "github.com/grafana/grafana/pkg/plugins/instrumentationutils"
plog "github.com/grafana/grafana/pkg/plugins/log" plog "github.com/grafana/grafana/pkg/plugins/log"
"github.com/grafana/grafana/pkg/plugins/manager/registry"
"github.com/grafana/grafana/pkg/plugins/pluginrequestmeta" "github.com/grafana/grafana/pkg/plugins/pluginrequestmeta"
) )
// NewLoggerMiddleware creates a new plugins.ClientMiddleware that will // NewLoggerMiddleware creates a new plugins.ClientMiddleware that will
// log requests. // log requests.
func NewLoggerMiddleware(logger plog.Logger) plugins.ClientMiddleware { func NewLoggerMiddleware(logger plog.Logger, pluginRegistry registry.Service) plugins.ClientMiddleware {
return plugins.ClientMiddlewareFunc(func(next plugins.Client) plugins.Client { return plugins.ClientMiddlewareFunc(func(next plugins.Client) plugins.Client {
return &LoggerMiddleware{ return &LoggerMiddleware{
baseMiddleware: baseMiddleware{ baseMiddleware: baseMiddleware{
next: next, next: next,
}, },
logger: logger, logger: logger,
pluginRegistry: pluginRegistry,
} }
}) })
} }
type LoggerMiddleware struct { type LoggerMiddleware struct {
baseMiddleware baseMiddleware
logger plog.Logger logger plog.Logger
pluginRegistry registry.Service
} }
func (m *LoggerMiddleware) logRequest(ctx context.Context, fn func(ctx context.Context) (instrumentationutils.RequestStatus, error)) error { func (m *LoggerMiddleware) pluginTarget(ctx context.Context, pCtx backend.PluginContext) string {
p, exists := m.pluginRegistry.Plugin(ctx, pCtx.PluginID, pCtx.PluginVersion)
if !exists {
return ""
}
return string(p.Target())
}
func (m *LoggerMiddleware) logRequest(ctx context.Context, pCtx backend.PluginContext, fn func(ctx context.Context) (instrumentationutils.RequestStatus, error)) error {
start := time.Now() start := time.Now()
timeBeforePluginRequest := log.TimeSinceStart(ctx, start) timeBeforePluginRequest := log.TimeSinceStart(ctx, start)
@ -41,6 +52,7 @@ func (m *LoggerMiddleware) logRequest(ctx context.Context, fn func(ctx context.C
"duration", time.Since(start), "duration", time.Since(start),
"eventName", "grafana-data-egress", "eventName", "grafana-data-egress",
"time_before_plugin_request", timeBeforePluginRequest, "time_before_plugin_request", timeBeforePluginRequest,
"target", m.pluginTarget(ctx, pCtx),
} }
if err != nil { if err != nil {
logParams = append(logParams, "error", err) logParams = append(logParams, "error", err)
@ -64,7 +76,7 @@ func (m *LoggerMiddleware) QueryData(ctx context.Context, req *backend.QueryData
} }
var resp *backend.QueryDataResponse var resp *backend.QueryDataResponse
err := m.logRequest(ctx, func(ctx context.Context) (instrumentationutils.RequestStatus, error) { err := m.logRequest(ctx, req.PluginContext, func(ctx context.Context) (instrumentationutils.RequestStatus, error) {
var innerErr error var innerErr error
resp, innerErr = m.next.QueryData(ctx, req) resp, innerErr = m.next.QueryData(ctx, req)
@ -96,7 +108,7 @@ func (m *LoggerMiddleware) CallResource(ctx context.Context, req *backend.CallRe
return m.next.CallResource(ctx, req, sender) return m.next.CallResource(ctx, req, sender)
} }
err := m.logRequest(ctx, func(ctx context.Context) (instrumentationutils.RequestStatus, error) { err := m.logRequest(ctx, req.PluginContext, func(ctx context.Context) (instrumentationutils.RequestStatus, error) {
innerErr := m.next.CallResource(ctx, req, sender) innerErr := m.next.CallResource(ctx, req, sender)
return instrumentationutils.RequestStatusFromError(innerErr), innerErr return instrumentationutils.RequestStatusFromError(innerErr), innerErr
}) })
@ -110,7 +122,7 @@ func (m *LoggerMiddleware) CheckHealth(ctx context.Context, req *backend.CheckHe
} }
var resp *backend.CheckHealthResult var resp *backend.CheckHealthResult
err := m.logRequest(ctx, func(ctx context.Context) (instrumentationutils.RequestStatus, error) { err := m.logRequest(ctx, req.PluginContext, func(ctx context.Context) (instrumentationutils.RequestStatus, error) {
var innerErr error var innerErr error
resp, innerErr = m.next.CheckHealth(ctx, req) resp, innerErr = m.next.CheckHealth(ctx, req)
return instrumentationutils.RequestStatusFromError(innerErr), innerErr return instrumentationutils.RequestStatusFromError(innerErr), innerErr
@ -125,7 +137,7 @@ func (m *LoggerMiddleware) CollectMetrics(ctx context.Context, req *backend.Coll
} }
var resp *backend.CollectMetricsResult var resp *backend.CollectMetricsResult
err := m.logRequest(ctx, func(ctx context.Context) (instrumentationutils.RequestStatus, error) { err := m.logRequest(ctx, req.PluginContext, func(ctx context.Context) (instrumentationutils.RequestStatus, error) {
var innerErr error var innerErr error
resp, innerErr = m.next.CollectMetrics(ctx, req) resp, innerErr = m.next.CollectMetrics(ctx, req)
return instrumentationutils.RequestStatusFromError(innerErr), innerErr return instrumentationutils.RequestStatusFromError(innerErr), innerErr
@ -140,7 +152,7 @@ func (m *LoggerMiddleware) SubscribeStream(ctx context.Context, req *backend.Sub
} }
var resp *backend.SubscribeStreamResponse var resp *backend.SubscribeStreamResponse
err := m.logRequest(ctx, func(ctx context.Context) (instrumentationutils.RequestStatus, error) { err := m.logRequest(ctx, req.PluginContext, func(ctx context.Context) (instrumentationutils.RequestStatus, error) {
var innerErr error var innerErr error
resp, innerErr = m.next.SubscribeStream(ctx, req) resp, innerErr = m.next.SubscribeStream(ctx, req)
return instrumentationutils.RequestStatusFromError(innerErr), innerErr return instrumentationutils.RequestStatusFromError(innerErr), innerErr
@ -155,7 +167,7 @@ func (m *LoggerMiddleware) PublishStream(ctx context.Context, req *backend.Publi
} }
var resp *backend.PublishStreamResponse var resp *backend.PublishStreamResponse
err := m.logRequest(ctx, func(ctx context.Context) (instrumentationutils.RequestStatus, error) { err := m.logRequest(ctx, req.PluginContext, func(ctx context.Context) (instrumentationutils.RequestStatus, error) {
var innerErr error var innerErr error
resp, innerErr = m.next.PublishStream(ctx, req) resp, innerErr = m.next.PublishStream(ctx, req)
return instrumentationutils.RequestStatusFromError(innerErr), innerErr return instrumentationutils.RequestStatusFromError(innerErr), innerErr
@ -169,7 +181,7 @@ func (m *LoggerMiddleware) RunStream(ctx context.Context, req *backend.RunStream
return m.next.RunStream(ctx, req, sender) return m.next.RunStream(ctx, req, sender)
} }
err := m.logRequest(ctx, func(ctx context.Context) (instrumentationutils.RequestStatus, error) { err := m.logRequest(ctx, req.PluginContext, func(ctx context.Context) (instrumentationutils.RequestStatus, error) {
innerErr := m.next.RunStream(ctx, req, sender) innerErr := m.next.RunStream(ctx, req, sender)
return instrumentationutils.RequestStatusFromError(innerErr), innerErr return instrumentationutils.RequestStatusFromError(innerErr), innerErr
}) })
@ -183,7 +195,7 @@ func (m *LoggerMiddleware) ValidateAdmission(ctx context.Context, req *backend.A
} }
var resp *backend.ValidationResponse var resp *backend.ValidationResponse
err := m.logRequest(ctx, func(ctx context.Context) (instrumentationutils.RequestStatus, error) { err := m.logRequest(ctx, req.PluginContext, func(ctx context.Context) (instrumentationutils.RequestStatus, error) {
var innerErr error var innerErr error
resp, innerErr = m.next.ValidateAdmission(ctx, req) resp, innerErr = m.next.ValidateAdmission(ctx, req)
return instrumentationutils.RequestStatusFromError(innerErr), innerErr return instrumentationutils.RequestStatusFromError(innerErr), innerErr
@ -198,7 +210,7 @@ func (m *LoggerMiddleware) MutateAdmission(ctx context.Context, req *backend.Adm
} }
var resp *backend.MutationResponse var resp *backend.MutationResponse
err := m.logRequest(ctx, func(ctx context.Context) (instrumentationutils.RequestStatus, error) { err := m.logRequest(ctx, req.PluginContext, func(ctx context.Context) (instrumentationutils.RequestStatus, error) {
var innerErr error var innerErr error
resp, innerErr = m.next.MutateAdmission(ctx, req) resp, innerErr = m.next.MutateAdmission(ctx, req)
return instrumentationutils.RequestStatusFromError(innerErr), innerErr return instrumentationutils.RequestStatusFromError(innerErr), innerErr
@ -213,7 +225,7 @@ func (m *LoggerMiddleware) ConvertObjects(ctx context.Context, req *backend.Conv
} }
var resp *backend.ConversionResponse var resp *backend.ConversionResponse
err := m.logRequest(ctx, func(ctx context.Context) (instrumentationutils.RequestStatus, error) { err := m.logRequest(ctx, req.PluginContext, func(ctx context.Context) (instrumentationutils.RequestStatus, error) {
var innerErr error var innerErr error
resp, innerErr = m.next.ConvertObjects(ctx, req) resp, innerErr = m.next.ConvertObjects(ctx, req)
return instrumentationutils.RequestStatusFromError(innerErr), innerErr return instrumentationutils.RequestStatusFromError(innerErr), innerErr

2
pkg/services/pluginsintegration/pluginsintegration.go
View File

@ -175,7 +175,7 @@ func CreateMiddlewares(cfg *setting.Cfg, oAuthTokenService oauthtoken.OAuthToken
} }
if cfg.PluginLogBackendRequests { if cfg.PluginLogBackendRequests {
middlewares = append(middlewares, clientmiddleware.NewLoggerMiddleware(log.New("plugin.instrumentation"))) middlewares = append(middlewares, clientmiddleware.NewLoggerMiddleware(log.New("plugin.instrumentation"), registry))
} }
skipCookiesNames := []string{cfg.LoginCookieName} skipCookiesNames := []string{cfg.LoginCookieName}