Add extra context to warnings

[QuentinBisson]

Description

This PR adds more context to the deprecation warnings to know which resource (pod and service monitor) is using deprecated values as the current message is not really helpful to track the resource with issues.

This PR also adds some extra logs for other deprecations.

Type of change

What type of changes does your code introduce to the Prometheus operator? Put an x in the box that apply.

• CHANGE (fix or feature that would cause existing functionality to not work as expected)
• FEATURE (non-breaking change which adds functionality)
• BUGFIX (non-breaking change which fixes an issue)
• ENHANCEMENT (non-breaking change which improves existing functionality)
• NONE (if none of the other choices apply. Example, tooling, build system, CI, docs, etc.)

Verification

Please check the Prometheus-Operator testing guidelines for recommendations about automated tests.

Changelog entry

Please put a one-line changelog entry below. This will be copied to the changelog file during the release process.

[simonpasquier]

Good catch! There might a bit more places where we have deprecated fields to log (.e.g. probes)?

[simonpasquier]

the logger should already have the pod_monitor="xxx/xxx" keyval.

Suggested change

	level.Warn(cg.logger).Log("msg", "'bearerTokenSecret' is deprecated, use 'authorization' instead.", "podmonitor", m.Name, "namespace", m.Namespace)
	level.Warn(cg.logger).Log("msg", "'bearerTokenSecret' is deprecated, use 'authorization' instead.")

[QuentinBisson]

Oh, maybe it can be added as a keyval to the logger at the top of the function instead, i'll check how.
I will also add a warning to the other deprecations

[QuentinBisson]

Oh yes you're right that it should but it's not showing in my logs for some reason

[simonpasquier]

hmm interesting.

[QuentinBisson]

So the weird part is that when i use logfmt, I have the following logs without the resource information

level=warn ts=2024-03-20T20:26:27.127226961Z caller=promcfg.go:819 component=prometheus-controller msg="'targetPort' is deprecated, use 'port' instead." version=v2.50.1
level=warn ts=2024-03-20T20:26:27.127415876Z caller=promcfg.go:819 component=prometheus-controller msg="'targetPort' is deprecated, use 'port' instead." version=v2.50.1

But when I use json is it there:

{"[pod_monitor crossplane/crossplane]":"(MISSING)","caller":"promcfg.go:819","component":"prometheus-controller","level":"warn","msg":"'targetPort' is deprecated, use 'port' instead.","ts":"2024-03-20T20:25:44.813625012Z","version":"v2.50.1"}

[QuentinBisson]

Oh i found the issue

[QuentinBisson]

I ran this little script:

func WithKeyVals(logger log.Logger, keyvals ...interface{}) log.Logger {
	return log.WithSuffix(logger, keyvals...)
}

func main() {
	logger := log.NewLogfmtLogger(log.NewSyncWriter(os.Stderr))
	logger = WithKeyVals(logger, "caller", log.DefaultCaller)
	level.Info(logger).Log("msg", "hello")
	level.Warn(logger).Log("msg", "hello")
}

And we do not add the spread operator (...) after keyvals in the WithKeyVals function, the we pass the keyval function parameter as an array hence this in json: "[pod_monitor crossplane/crossplane]":"(MISSING)"

[QuentinBisson]

@simonpasquier this is the fix to make sure the pod_monitor key is in the logs

[QuentinBisson]

This is actually not deprectated as per the doc page

[simonpasquier]

Thanks!