Improve logging in Controllers by adding relevant context

[bacherfl]

Details

Right now, the controllers often produce logs that do not provide much value, due to missing context. A good example for that is this one:

lifecycle-toolkit/lifecycle-operator/controllers/lifecycle/keptnappversion/controller.go

Line 75 in 2558f74

r.Log.Info("Searching for Keptn App Version")

This will generate something like:

2023-08-10T14:28:25Z	INFO	KeptnAppVersion Controller	Searching for Keptn App Version

On one side, this is helpful to indicate the start of a new reconciliation loop, but does not help much if I want to use the logs for debugging the reconciliation of a particular object in a cluster with a large number of resources. In some other places, this is done better by making use of the keysAndValues parameter of the logger's logging functions, where a list of keys and values is attached to a log line, as in the following:

2023-08-10T14:28:25Z	INFO	owner of pod is not supported by lifecycle controller	{"webhook": "/mutate-v1-pod", "object": {"kind":{"group":"","version":"v1","kind":"Pod"},"name":"","namespace":"kuttl-test-hot-gar"}, "namespace": "kuttl-test-hot-gar", "pod": ""}

Adding this context makes it way easier to actually use the logs for troubleshooting by filtering on e.g. a certain namespace, or the name of a resource.

The goal of this ticket should be to figure out a set of properties that should be attached to each log line, and make these available via a common function. Properties like name, namespace kind are good candidates, but others may also prove to be useful.

DoD

• One PR per operator: lifecycle, cert-manager, metrics, scheduler
• Log lines produced by the controllers contain contextual information which can be used to efficiently troubleshoot issues using the logs

[ShivangShandilya]

I would like to work on this @bacherfl

[thisthat]

@sudiptob2 this is the issue we discussed

[geoffrey1330]

@thisthat Could you please assign this issue to me

[bacherfl]

reopening because the merged PR #2253 is part of the issue, but the other operators remain to be improved

[ShivangShandilya]

@geoffrey1330 you gotta explain to me how you solved this issue 😄
Would help me a ton

[geoffrey1330]

@geoffrey1330 you gotta explain to me how you solved this issue 😄 Would help me a ton

Sure. you can hit me up on keptn slack channel