Make logging.InitializeDefaultLogger private #29495
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
learnitall
added
area/daemon
learnitall
force-pushed
the
pr/learnitall/make-initialize-private
branch
from
86cbd02
to
4e820dc
Compare
|
/test |
learnitall
changed the title
The release notes are user-facing and thus ideally should document the impact a user will see because of this change. How about saying what issue this PR fixes? |
tklauser
requested changes
Nov 30, 2023
learnitall
force-pushed
the
pr/learnitall/make-initialize-private
branch
from
4e820dc
to
bdab87c
Compare
Ah good point, I'll update it. |
learnitall
force-pushed
the
pr/learnitall/make-initialize-private
branch
from
bdab87c
to
350c424
Compare
|
/test |
The function InitializeDefaultLogger creates a new logger with the default settings and returns it. This commit removes a call to this function that doesn't save the return value, essentially calling it for no reason. Signed-off-by: Ryan Drew <ryan.drew@isovalent.com>
The DefaultLogger variable in the logging module serves as a parent logger which all other loggers can be derived from. It is initialized using the InitializeDefaultLogger function and then adjusted on startup based on user configuration. Users should not call InitializeDefaultLogger to create a parent logger for their logger, since the logger returned by InitializeDefaultLogger will always use the hardcoded defaults. For example, the logger returned will always be of level INFO, even if a user has enabled debug logging. To make this clear, this commit renames InitializeDefaultLogger to initializeDefaultLogger to signal that it should not be used outside of the logging module. Fixes: cilium#29215 Signed-off-by: Ryan Drew <ryan.drew@isovalent.com>
tklauser
force-pushed
the
pr/learnitall/make-initialize-private
branch
from
350c424
to
7cdd9e6
Compare
|
Rebased to pull in #29455 fixing ci-runtime |
|
/test |
tklauser
approved these changes
Dec 1, 2023
maintainer-s-little-helper
bot
added
the
ready-to-merge
tklauser
added
needs-backport/1.13
|
According to #29544 (comment) it seems that #29215 also occurs on v1.13 (and presumably also v1.14). I've added the corresponding labels but I assume that they might need manual backports. |
|
Sounds good @tklauser, I'll keep a look out. |
nbusseneau
added
the
backport/author
|
@learnitall Indeed this will need manual backports, as the changes depend on changes made in #26327 and #23971 which were not backported. I will skip this PR in the current round of backports and added the |
|
Hi, FYI I opened a backport PR for 1.13 since this bug affects us in that version: #29700 |
tklauser
added
backport-pending/1.13
maintainer-s-little-helper
bot
moved this from Needs backport from main
to Backport pending to v1.13
in 1.13.10
maintainer-s-little-helper
bot
moved this from Needs backport from main
to Backport pending to v1.13
in 1.13.10
github-actions
bot
added
backport-done/1.13
tklauser
added
backport-pending/1.14
github-actions
bot
added
backport-done/1.14
gentoo-root
moved this from Needs backport from main
to Backport done to v1.14
in 1.14.6
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Please ensure your pull request adheres to the following guidelines:
description and a
Fixes: #XXXline if the commit addresses a particularGitHub issue.
Fixes: <commit-id>tag, thenplease add the commit author[s] as reviewer[s] to this issue.
This PR renames the function
logging.InitializeDefaultLoggertologging.initializeDefaultLoggerin order to make it private to the logging module. This function should only be used to initialize thelogging.DefaultLoggervariable, and should not be used by users as a parent logger. This is because the logger returned bylogging.InitializeDefaultLoggerwill always use the hard-coded default logging settings, whilelogging.DefaultLoggeris adjusted based on the user configuration.The changes in
pkg/endpoint/log.goremove the use oflogging.InitializeDefaultLoggerwhile also fixing #29215.Fixes: #29215