Logging: Add WithContextualAttributes to pass log params based on the given context
#74428
Conversation
svennergr
changed the title
RegisterContextualLogProviderRegisterContextualLogProvider to pass log params to data source loggers
| @@ -146,6 +149,14 @@ func NewClientDecorator( | |||
| c := client.ProvideService(pluginRegistry, pCfg) | |||
| middlewares := CreateMiddlewares(cfg, oAuthTokenService, tracer, cachingService, features) | |||
|
|
|||
| log.RegisterContextualLogProvider(func(ctx context.Context) ([]any, bool) { | |||
There was a problem hiding this comment.
Since WithContextualAttributes is in the log package I would recommend putting this in there as well/together with it in the same package and by so you don't need to expose log.LogParamsContextKey.
| @@ -123,4 +130,9 @@ func reverseMiddlewares(middlewares []plugins.ClientMiddleware) []plugins.Client | |||
| return reversed | |||
| } | |||
|
|
|||
| func instrumentContext(ctx context.Context, endpoint string, pCtx backend.PluginContext) context.Context { | |||
There was a problem hiding this comment.
With the approach you did choose I think you can keep this in instrumentation.go for now as you had initially.
There was a problem hiding this comment.
With that I needed to change the function signature in e.g. InstrumentCallResourceRequest to also contain the context:https://github.com/grafana/grafana/pull/74428/files#diff-f68ce913764de9b2ec9c118f29476e2aeec3981d7561124e48659e5a8c2c6f78L111
Let me know what you think.
svennergr
changed the title
RegisterContextualLogProvider to pass log params to data source loggersWithContextualAttributes to pass log params based on the given context
There was a problem hiding this comment.
Yay for this! Great job @svennergr for tackling this at backend plugin level rather than us having to pass these to every log individually. 🚀
…he given context (grafana#74428) * suggestion to use `RegisterContextualLogProvider` * add `pluginId` * change to `WithContextualAttributes` * move approach to instrumentation.go * improve `WithContextualAttributes` * unexport consts * typo * remove comment * add `nil` check
…he given context (#74428) * suggestion to use `RegisterContextualLogProvider` * add `pluginId` * change to `WithContextualAttributes` * move approach to instrumentation.go * improve `WithContextualAttributes` * unexport consts * typo * remove comment * add `nil` check
What is this feature?
This PR adds
WithContextualAttributesmethod, that will just register some labels/log-parameters on the given context and return a new context with those values. If a new logger is created withlogger.FromContext, those parameters will automatically be prepended.This is especially useful for datasource loggers to also include the
endpoint,dsName,dsUIDandpluginId.