Add logging interface to decouple implementation from codebase #9847
Conversation
This file contains hidden or 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
marvin-tigera
added
release-note-required
Brian-McM
force-pushed
the
bm-add-logging-interface
branch
2 times, most recently
from
dd08d87 to
d4b50d4
Compare
Brian-McM
force-pushed
the
bm-add-logging-interface
branch
4 times, most recently
from
c14572e to
3757438
Compare
Brian-McM
force-pushed
the
bm-add-logging-interface
branch
14 times, most recently
from
9fd1d92 to
84a901a
Compare
Brian-McM
added
docs-not-required
Brian-McM
force-pushed
the
bm-add-logging-interface
branch
from
8a3d58d to
fd9ff7b
Compare
Brian-McM
force-pushed
the
bm-add-logging-interface
branch
11 times, most recently
from
fd0b803 to
0aaf83a
Compare
This commit adds custom logging interface to wrap our logger implementation (currently logrus) in the lib/std folder and move all logutilities into the lib/log folder. This replaces all references to logrus and libcalico/logutils in the project to use lib/std/log to ensure the logging interface includes everything we need. Some initial benefits are:
-- Forces all uses of logging in the repo to use our agreed upon formatting / customizations. This cuts down on code to setup loggers and ensures optimizations are used everywhere.
-- Ensures logrus dep conflicts don't happen between main module and lib modules since the only direct import of logrus would be in lib/log.
-- Interface ensures tests can easily swap out implementation for mock implementation.
I've added testutils/assert library to help with writing tests in the lib modules, as we don't want to import ginkgo or testify in the lib modules as they might cause dependency issues with the main module.
Brian-McM
force-pushed
the
bm-add-logging-interface
branch
from
0aaf83a to
32d7786
Compare
fasaxc
reviewed
May 23, 2025
| } | ||
| } | ||
|
|
||
| // FormatForSyslog formats logs in a way tailored for syslogrus. It avoids logging information that is |
|
This PR is stale because it has been open for 60 days with no activity. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
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.
Description
This commit adds custom logging interface to wrap our logger implementation (currently logrus) in the lib/std folder and move all logutilities into the lib/log folder. This replaces all references to logrus and libcalico/logutils in the project to use lib/std/log to ensure the logging interface includes everything we need. Some initial benefits are:
I've added testutils/assert library to help with writing tests in the lib modules, as we don't want to import ginkgo or testify in the lib modules as they might cause dependency issues with the main module.
Related issues/PRs
Todos
Release Note
Reminder for the reviewer
Make sure that this PR has the correct labels and milestone set.
Every PR needs one
docs-*label.docs-pr-required: This change requires a change to the documentation that has not been completed yet.docs-completed: This change has all necessary documentation completed.docs-not-required: This change has no user-facing impact and requires no docs.Every PR needs one
release-note-*label.release-note-required: This PR has user-facing changes. Most PRs should have this label.release-note-not-required: This PR has no user-facing changes.Other optional labels:
cherry-pick-candidate: This PR should be cherry-picked to an earlier release. For bug fixes only.needs-operator-pr: This PR is related to install and requires a corresponding change to the operator.