⚠ logging: align to Kubernetes structured logging, add reconcileID

[sbueringer]

Signed-off-by: Stefan Büringer [email protected]

For more details, please see: #1826

This PR introduces the LogConstructor controller option which replaces the previous Log option.
LogConstructor creates a Logger on-demand either within the context of a reconciliation based on a *reconcile.Request or outside of it (then nil is passed in).

Through this PR the logs change as follows:

When the controller is created with the builder:

-  "msg": "controller/cluster: Waiting for DockerCluster",
+  "msg": "Waiting for DockerCluster",
+  "cluster": {
+     "name": "capi-quickstart",
+     "namespace": "default"
+   },
-  "reconciler group": "cluster.x-k8s.io",
-  "reconciler kind": "Cluster",
+  "controllerGroup": "cluster.x-k8s.io",
+  "controllerKind": "Cluster",
+  "reconcileID": "56e044eb38fb76741ffe41cd83e7bed5",

When the controller is created with controller.New or controller.NewUnmanaged:

-  "msg": "controller/cluster: Waiting for DockerCluster",
+  "msg": "Waiting for DockerCluster",
+  "object": {
+     "name": "capi-quickstart",
+     "namespace": "default"
+   },
+  "reconcileID": "56e044eb38fb76741ffe41cd83e7bed5",

The output of the text format changed similarly. Although the objects are just formatted as <namespace>/<name> in this case (when using klog).

Please note by providing a LogConstructor via controller options everything except the reconcileID can be overwritten.

Fixes #1826

[sbueringer]

/test pull-controller-runtime-test-master
Not sure if it's related, but let's see.

I'm seeing similar failed tests on the periodic job: https://prow.k8s.io/job-history/gs/kubernetes-jenkins/logs/periodic-controller-runtime-test-master

[sbueringer]

@alvaroaleman Findings should be addressed or answered, PTAL. Thank you very much!

[k8s-ci-robot]

@sbueringer: The following test failed, say /retest to rerun all failed tests or /retest-required to rerun all mandatory failed tests:

Test name	Commit	Details	Required	Rerun command
pull-controller-runtime-apidiff-master	598978c	link	false	/test pull-controller-runtime-apidiff-master

Full PR test history. Your PR dashboard. Please help us cut down on flakes by linking to an open issue when you hit one in your PR.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository. I understand the commands that are listed here.

[alvaroaleman]

looks good to me, thanks for the work!
/hold
@joelanford @vincepri any concerns or objections?

[vincepri]

/approve
/lgtm

[vincepri]

+1 from me to merge

[k8s-ci-robot]

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: alvaroaleman, sbueringer, vincepri

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

• OWNERS [alvaroaleman,vincepri]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

[FillZpp]

/hold cancel

[sbueringer]

Thanks everyone for the quick feedback and good discussions! :)