🌱 Add ctrl.{LoggerFrom, LoggerInto} #1202
Conversation
Renames the current (unreleased at the time of writing)
LoggerFromContext to LoggerFrom, and adds a new alias named LoggerInto.
From a user standpoint these new aliases are really clear and
straightfoward, example:
```go
func (r *Reconciler) Reconcile(ctx context.Context, req ctrl.Request) {
log := ctrl.LoggerFrom(ctx)
```
This reads much better than ctrl.LoggerFromContext(ctx) which repeats
the context.
Another use case that this change solves is to enrich the logger with
more values, example:
```go
ctx = ctrl.LoggerInto(ctx, log.WithValues(...))
```
allows the ctx to still be the de-facto context, and the logger for the
inner reconciler function to still only accept ctx, without adding any
more parameters.
Signed-off-by: Vince Prignano <[email protected]>
k8s-ci-robot
added
the
cncf-cla: yes
k8s-ci-robot
added
approved
|
@vincepri: The following test failed, say
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. |
k8s-ci-robot
added
the
lgtm
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: alvaroaleman, 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:
Approvers can indicate their approval by writing |
Renames the current (unreleased at the time of writing)
LoggerFromContext to LoggerFrom, and adds a new alias named LoggerInto.
From a user standpoint these new aliases are really clear and
straightfoward, example:
This reads much better than ctrl.LoggerFromContext(ctx) which repeats
the context.
Another use case that this change solves is to enrich the logger with
more values, example:
allows the ctx to still be the de-facto context, and the logger for the
inner reconciler function to still only accept ctx, without adding any
more parameters.
Signed-off-by: Vince Prignano [email protected]
/milestone v0.7.x
/assign @DirectXMan12 @alvaroaleman