-
Notifications
You must be signed in to change notification settings - Fork 0
Plugins: Chore: Renamed instrumentation middleware to metrics middleware #8
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
akshayutture-augment
wants to merge
1
commit into
main
Choose a base branch
from
plugins/rename-instrumentation-middleware-to-metrics-middleware
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,35 +1,40 @@ | ||
| package log | ||
|
|
||
| import "context" | ||
|
|
||
| // Logger is the default logger | ||
| type Logger interface { | ||
| // New returns a new contextual Logger that has this logger's context plus the given context. | ||
| New(ctx ...interface{}) Logger | ||
| New(ctx ...any) Logger | ||
|
|
||
| // Debug logs a message with debug level and key/value pairs, if any. | ||
| Debug(msg string, ctx ...interface{}) | ||
| Debug(msg string, ctx ...any) | ||
|
|
||
| // Info logs a message with info level and key/value pairs, if any. | ||
| Info(msg string, ctx ...interface{}) | ||
| Info(msg string, ctx ...any) | ||
|
|
||
| // Warn logs a message with warning level and key/value pairs, if any. | ||
| Warn(msg string, ctx ...interface{}) | ||
| Warn(msg string, ctx ...any) | ||
|
|
||
| // Error logs a message with error level and key/value pairs, if any. | ||
| Error(msg string, ctx ...interface{}) | ||
| Error(msg string, ctx ...any) | ||
|
|
||
| // FromContext returns a new contextual Logger that has this logger's context plus the given context. | ||
| FromContext(ctx context.Context) Logger | ||
| } | ||
|
|
||
| // PrettyLogger is used primarily to facilitate logging/user feedback for both | ||
| // the grafana-cli and the grafana backend when managing plugin installs | ||
| type PrettyLogger interface { | ||
| Successf(format string, args ...interface{}) | ||
| Failuref(format string, args ...interface{}) | ||
|
|
||
| Info(args ...interface{}) | ||
| Infof(format string, args ...interface{}) | ||
| Debug(args ...interface{}) | ||
| Debugf(format string, args ...interface{}) | ||
| Warn(args ...interface{}) | ||
| Warnf(format string, args ...interface{}) | ||
| Error(args ...interface{}) | ||
| Errorf(format string, args ...interface{}) | ||
| Successf(format string, args ...any) | ||
| Failuref(format string, args ...any) | ||
|
|
||
| Info(args ...any) | ||
| Infof(format string, args ...any) | ||
| Debug(args ...any) | ||
| Debugf(format string, args ...any) | ||
| Warn(args ...any) | ||
| Warnf(format string, args ...any) | ||
| Error(args ...any) | ||
| Errorf(format string, args ...any) | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
69 changes: 69 additions & 0 deletions
69
pkg/services/pluginsintegration/clientmiddleware/contextual_logger_middleware.go
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,69 @@ | ||
| package clientmiddleware | ||
|
|
||
| import ( | ||
| "context" | ||
|
|
||
| "github.com/grafana/grafana-plugin-sdk-go/backend" | ||
|
|
||
| "github.com/grafana/grafana/pkg/infra/log" | ||
| "github.com/grafana/grafana/pkg/plugins" | ||
| ) | ||
|
|
||
| // NewContextualLoggerMiddleware creates a new plugins.ClientMiddleware that adds | ||
| // a contextual logger to the request context. | ||
| func NewContextualLoggerMiddleware() plugins.ClientMiddleware { | ||
| return plugins.ClientMiddlewareFunc(func(next plugins.Client) plugins.Client { | ||
| return &ContextualLoggerMiddleware{ | ||
| next: next, | ||
| } | ||
| }) | ||
| } | ||
|
|
||
| type ContextualLoggerMiddleware struct { | ||
| next plugins.Client | ||
| } | ||
|
|
||
| // instrumentContext adds a contextual logger with plugin and request details to the given context. | ||
| func instrumentContext(ctx context.Context, endpoint string, pCtx backend.PluginContext) context.Context { | ||
| p := []any{"endpoint", endpoint, "pluginId", pCtx.PluginID} | ||
| if pCtx.DataSourceInstanceSettings != nil { | ||
| p = append(p, "dsName", pCtx.DataSourceInstanceSettings.Name) | ||
| p = append(p, "dsUID", pCtx.DataSourceInstanceSettings.UID) | ||
| } | ||
| if pCtx.User != nil { | ||
| p = append(p, "uname", pCtx.User.Login) | ||
| } | ||
| return log.WithContextualAttributes(ctx, p) | ||
| } | ||
|
|
||
| func (m *ContextualLoggerMiddleware) QueryData(ctx context.Context, req *backend.QueryDataRequest) (*backend.QueryDataResponse, error) { | ||
| ctx = instrumentContext(ctx, endpointQueryData, req.PluginContext) | ||
| return m.next.QueryData(ctx, req) | ||
| } | ||
|
|
||
| func (m *ContextualLoggerMiddleware) CallResource(ctx context.Context, req *backend.CallResourceRequest, sender backend.CallResourceResponseSender) error { | ||
| ctx = instrumentContext(ctx, endpointCallResource, req.PluginContext) | ||
| return m.next.CallResource(ctx, req, sender) | ||
| } | ||
|
|
||
| func (m *ContextualLoggerMiddleware) CheckHealth(ctx context.Context, req *backend.CheckHealthRequest) (*backend.CheckHealthResult, error) { | ||
| ctx = instrumentContext(ctx, endpointCheckHealth, req.PluginContext) | ||
| return m.next.CheckHealth(ctx, req) | ||
| } | ||
|
|
||
| func (m *ContextualLoggerMiddleware) CollectMetrics(ctx context.Context, req *backend.CollectMetricsRequest) (*backend.CollectMetricsResult, error) { | ||
| ctx = instrumentContext(ctx, endpointCollectMetrics, req.PluginContext) | ||
| return m.next.CollectMetrics(ctx, req) | ||
| } | ||
|
|
||
| func (m *ContextualLoggerMiddleware) SubscribeStream(ctx context.Context, req *backend.SubscribeStreamRequest) (*backend.SubscribeStreamResponse, error) { | ||
| return m.next.SubscribeStream(ctx, req) | ||
| } | ||
|
|
||
| func (m *ContextualLoggerMiddleware) PublishStream(ctx context.Context, req *backend.PublishStreamRequest) (*backend.PublishStreamResponse, error) { | ||
| return m.next.PublishStream(ctx, req) | ||
| } | ||
|
|
||
| func (m *ContextualLoggerMiddleware) RunStream(ctx context.Context, req *backend.RunStreamRequest, sender *backend.StreamSender) error { | ||
| return m.next.RunStream(ctx, req, sender) | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Guard against nil requests to avoid panics in ContextualLoggerMiddleware
Each of these methods dereferences
req(viareq.PluginContext) without a nil check, unlikeLoggerMiddleware, which explicitly handlesreq == nil. If any existing caller can pass a nil request, this middleware will now panic.Recommend short‑circuiting to
nextwhenreqis nil, mirroringLoggerMiddleware:func (m *ContextualLoggerMiddleware) QueryData(ctx context.Context, req *backend.QueryDataRequest) (*backend.QueryDataResponse, error) { - ctx = instrumentContext(ctx, endpointQueryData, req.PluginContext) - return m.next.QueryData(ctx, req) + if req == nil { + return m.next.QueryData(ctx, req) + } + ctx = instrumentContext(ctx, endpointQueryData, req.PluginContext) + return m.next.QueryData(ctx, req) } func (m *ContextualLoggerMiddleware) CallResource(ctx context.Context, req *backend.CallResourceRequest, sender backend.CallResourceResponseSender) error { - ctx = instrumentContext(ctx, endpointCallResource, req.PluginContext) - return m.next.CallResource(ctx, req, sender) + if req == nil { + return m.next.CallResource(ctx, req, sender) + } + ctx = instrumentContext(ctx, endpointCallResource, req.PluginContext) + return m.next.CallResource(ctx, req, sender) } func (m *ContextualLoggerMiddleware) CheckHealth(ctx context.Context, req *backend.CheckHealthRequest) (*backend.CheckHealthResult, error) { - ctx = instrumentContext(ctx, endpointCheckHealth, req.PluginContext) - return m.next.CheckHealth(ctx, req) + if req == nil { + return m.next.CheckHealth(ctx, req) + } + ctx = instrumentContext(ctx, endpointCheckHealth, req.PluginContext) + return m.next.CheckHealth(ctx, req) } func (m *ContextualLoggerMiddleware) CollectMetrics(ctx context.Context, req *backend.CollectMetricsRequest) (*backend.CollectMetricsResult, error) { - ctx = instrumentContext(ctx, endpointCollectMetrics, req.PluginContext) - return m.next.CollectMetrics(ctx, req) + if req == nil { + return m.next.CollectMetrics(ctx, req) + } + ctx = instrumentContext(ctx, endpointCollectMetrics, req.PluginContext) + return m.next.CollectMetrics(ctx, req) }This keeps behavior consistent with the existing logger middleware and avoids introducing a crash surface.
📝 Committable suggestion
🤖 Prompt for AI Agents