Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

馃尡 Add ctrl.{LoggerFrom, LoggerInto} #1202

Merged
merged 1 commit into from Oct 2, 2020

Conversation

vincepri
Copy link
Member

@vincepri vincepri commented Oct 2, 2020

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:

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:

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 vincepri@vmware.com

/milestone v0.7.x
/assign @DirectXMan12 @alvaroaleman

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 <vincepri@vmware.com>
@k8s-ci-robot k8s-ci-robot added this to the v0.7.x milestone Oct 2, 2020
@k8s-ci-robot k8s-ci-robot added the cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. label Oct 2, 2020
@k8s-ci-robot k8s-ci-robot added approved Indicates a PR has been approved by an approver from all required OWNERS files. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Oct 2, 2020
@k8s-ci-robot
Copy link
Contributor

@vincepri: The following test failed, say /retest to rerun all failed tests:

Test name Commit Details Rerun command
pull-controller-runtime-apidiff-master 8a00ec4 link /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.

Copy link
Member

@alvaroaleman alvaroaleman left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/lgtm
/approve

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Oct 2, 2020
@k8s-ci-robot
Copy link
Contributor

[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:
  • 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

@k8s-ci-robot k8s-ci-robot merged commit e50bc83 into kubernetes-sigs:master Oct 2, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. lgtm "Looks good to me", indicates that a PR is ready to be merged. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants