fix: SetLogger via klog.SetLogger will output an unexpected newline #378

aimuz · 2023-05-11T14:37:43Z

klog always adds a newline to the msg. klog will work fine without klog.

Set logr with klog.SetLogger, and klog will also pass the msg with the newline added to logr, which will result in an accidental newline being added.

step1: klog.Info("hello world")
step2: msg = msg + "\n"
step3: stdout.W(msg) or logr.Info(msg[:len(msg)-1])

fixes #370

Signed-off-by: aimuz [email protected]

What this PR does / why we need it:

Which issue(s) this PR fixes (optional, in fixes #<issue number>(, fixes #<issue_number>, ...) format, will close the issue(s) when PR gets merged):
Fixes #

Special notes for your reviewer:

Please confirm that if this PR changes any image versions, then that's the sole change this PR makes.

Release note:

NONE

k8s-ci-robot · 2023-05-11T14:37:51Z

This issue is currently awaiting triage.

If klog contributors determine this is a relevant issue, they will accept it by applying the triage/accepted label and provide further guidance.

The triage/accepted label can be added by org members by writing /triage accepted in a comment.

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.

dims · 2023-05-11T15:42:24Z

/assign @pohly

pohly · 2023-05-15T08:37:39Z

@aimuz: to reproduce the test failures, use go test ./... && (cd examples && go test ./...).

aimuz · 2023-05-15T10:57:42Z

thanks you @pohly

aimuz · 2023-05-17T01:58:30Z

PR is ready, please feel free to review

pohly · 2023-05-17T05:58:34Z

klog.go

@@ -873,6 +873,9 @@ func (l *loggingT) output(s severity.Severity, logger *logWriter, buf *buffer.Bu
 		if logger.writeKlogBuffer != nil {
 			logger.writeKlogBuffer(data)
 		} else {
+			if data[len(data)-1] == '\n' {


I know, data can probably never be empty, but perhaps check for it anyway?

Yes, it is necessary that

done

pohly

Looks good. Can you squash into one commit with a useful commit message?

pohly · 2023-05-17T08:34:36Z

The first commit message is already okay, no need to edit it.

klog always adds a newline to the msg. klog will work fine without klog. Set logr with klog.SetLogger, and klog will also pass the msg with the newline added to logr, which will result in an accidental newline being added. step1: klog.Info("hello world") step2: msg = msg + "\n" step3: stdout.W(msg) or logr.Info(msg[:len(msg)-1]) fix kubernetes#370 Signed-off-by: aimuz <[email protected]>

aimuz · 2023-05-17T10:06:54Z

done

pohly

/lgtm
/approve

Dropping a newline at the end of the message when using klog calls is an intentional improvement (kubernetes/klog#378) Kubernetes-commit: 878d037d3ba8fc4f11bf45a6cf5a66301ba89d82

[![Mend Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com) This PR contains the following updates: | Package | Type | Update | Change | |---|---|---|---| | [k8s.io/klog/v2](https://togithub.com/kubernetes/klog) | require | minor | `v2.100.1` -> `v2.110.1` | --- ### Release Notes <details> <summary>kubernetes/klog (k8s.io/klog/v2)</summary> ### [`v2.110.1`](https://togithub.com/kubernetes/klog/releases/tag/v2.110.1): Prepare klog release for Kubernetes v1.29 (Take 1) [Compare Source](https://togithub.com/kubernetes/klog/compare/v2.100.1...v2.110.1) #### What's Changed - fix: SetLogger via klog.SetLogger will output an unexpected newline by [@aimuz](https://togithub.com/aimuz) in [https://github.com/kubernetes/klog/pull/378](https://togithub.com/kubernetes/klog/pull/378) - resolve comments warning by [@lowang-bh](https://togithub.com/lowang-bh) in [https://github.com/kubernetes/klog/pull/379](https://togithub.com/kubernetes/klog/pull/379) - stderrthreshold: fix flag comment by [@pohly](https://togithub.com/pohly) in [https://github.com/kubernetes/klog/pull/376](https://togithub.com/kubernetes/klog/pull/376) - enable "go vet" checks for parameters by [@pohly](https://togithub.com/pohly) in [https://github.com/kubernetes/klog/pull/390](https://togithub.com/kubernetes/klog/pull/390) - promote experimental code to stable by [@pohly](https://togithub.com/pohly) in [https://github.com/kubernetes/klog/pull/392](https://togithub.com/kubernetes/klog/pull/392) - golangci-lint action by [@pohly](https://togithub.com/pohly) in [https://github.com/kubernetes/klog/pull/380](https://togithub.com/kubernetes/klog/pull/380) - output: handle WithName like zapr does by [@pohly](https://togithub.com/pohly) in [https://github.com/kubernetes/klog/pull/391](https://togithub.com/kubernetes/klog/pull/391) - slog support + logr 1.3.0 update by [@pohly](https://togithub.com/pohly) in [https://github.com/kubernetes/klog/pull/384](https://togithub.com/kubernetes/klog/pull/384) #### New Contributors - [@aimuz](https://togithub.com/aimuz) made their first contribution in [https://github.com/kubernetes/klog/pull/378](https://togithub.com/kubernetes/klog/pull/378) - [@lowang-bh](https://togithub.com/lowang-bh) made their first contribution in [https://github.com/kubernetes/klog/pull/379](https://togithub.com/kubernetes/klog/pull/379) **Full Changelog**: kubernetes/klog@v2.100.1...v2.110.1 </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] If you want to rebase/retry this PR, check this box --- This PR has been generated by [Mend Renovate](https://www.mend.io/free-developer-tools/renovate/). View repository job log [here](https://developer.mend.io/github/hetznercloud/hcloud-cloud-controller-manager).  Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

Fix for kubernetes/klog#378. Signed-off-by: Steve Kriss <[email protected]>

Dropping a newline at the end of the message when using klog calls is an intentional improvement (kubernetes/klog#378)

Dropping a newline at the end of the message when using klog calls is an intentional improvement (kubernetes/klog#378)

k8s-ci-robot added do-not-merge/invalid-commit-message Indicates that a PR should not merge because it has an invalid commit message. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. labels May 11, 2023

k8s-ci-robot requested review from harshanarayana and pohly May 11, 2023 14:37

k8s-ci-robot added the needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. label May 11, 2023

k8s-ci-robot added the size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. label May 11, 2023

aimuz force-pushed the fix-370 branch from 8aba960 to 37def3b Compare May 11, 2023 14:38

k8s-ci-robot removed the do-not-merge/invalid-commit-message Indicates that a PR should not merge because it has an invalid commit message. label May 11, 2023

aimuz force-pushed the fix-370 branch 2 times, most recently from b56182d to ef55402 Compare May 11, 2023 14:44

k8s-ci-robot assigned pohly May 11, 2023

aimuz changed the title ~~fix: SetLogger via klog.SetLogger will output an unexpected newline~~ wip: fix: SetLogger via klog.SetLogger will output an unexpected newline May 12, 2023

k8s-ci-robot added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label May 12, 2023

aimuz changed the title ~~wip: fix: SetLogger via klog.SetLogger will output an unexpected newline~~ fix: SetLogger via klog.SetLogger will output an unexpected newline May 17, 2023

k8s-ci-robot added size/S Denotes a PR that changes 10-29 lines, ignoring generated files. and removed do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels May 17, 2023

pohly reviewed May 17, 2023

View reviewed changes

aimuz requested a review from pohly May 17, 2023 06:22

pohly suggested changes May 17, 2023

View reviewed changes

aimuz force-pushed the fix-370 branch from 5c4e670 to 1e2789b Compare May 17, 2023 10:06

pohly approved these changes May 17, 2023

View reviewed changes

skriss added a commit to projectcontour/contour that referenced this pull request Nov 7, 2023

fix unit test

00d6c3c

Fix for kubernetes/klog#378. Signed-off-by: Steve Kriss <[email protected]>

platform-engineering-bot mentioned this pull request Dec 22, 2023

Update go updates arcalot/arcaflow-engine#136

Merged

1 task

richabanker pushed a commit to richabanker/kubernetes that referenced this pull request Jan 9, 2024

dependencies: klog v2.110.1

968b735

Dropping a newline at the end of the message when using klog calls is an intentional improvement (kubernetes/klog#378)

jiahuif pushed a commit to jiahuif-forks/kubernetes that referenced this pull request Jan 23, 2024

dependencies: klog v2.110.1

70418c7

Dropping a newline at the end of the message when using klog calls is an intentional improvement (kubernetes/klog#378)

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix: SetLogger via klog.SetLogger will output an unexpected newline #378

fix: SetLogger via klog.SetLogger will output an unexpected newline #378

aimuz commented May 11, 2023 •

edited

Loading

k8s-ci-robot commented May 11, 2023

dims commented May 11, 2023

pohly commented May 15, 2023

aimuz commented May 15, 2023

aimuz commented May 17, 2023

pohly May 17, 2023

aimuz May 17, 2023

pohly left a comment

pohly commented May 17, 2023

aimuz commented May 17, 2023

pohly left a comment

fix: SetLogger via klog.SetLogger will output an unexpected newline #378

fix: SetLogger via klog.SetLogger will output an unexpected newline #378

Conversation

aimuz commented May 11, 2023 • edited Loading

k8s-ci-robot commented May 11, 2023

dims commented May 11, 2023

pohly commented May 15, 2023

aimuz commented May 15, 2023

aimuz commented May 17, 2023

pohly May 17, 2023

Choose a reason for hiding this comment

aimuz May 17, 2023

Choose a reason for hiding this comment

pohly left a comment

Choose a reason for hiding this comment

pohly commented May 17, 2023

aimuz commented May 17, 2023

pohly left a comment

Choose a reason for hiding this comment

aimuz commented May 11, 2023 •

edited

Loading