update(output): complete rework of the output system #335
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
alacuku
force-pushed
the
kcl/refactor-output-subsystem
branch
from
8d051f3
to
248e093
Compare
FedeDP
reviewed
Oct 25, 2023
Old flags "--verbose" and "--disable-styling" have been deprecated. Two new flags configure the output system: * --log-level can be one of info, warn debug or trace. * --log-format can be one of color, text, json. The output is done using a logger that is used across all commands. Having a unique logger guarantees a consistent format of the output. Signed-off-by: Aldo Lacuku <[email protected]>
alacuku
force-pushed
the
kcl/refactor-output-subsystem
branch
from
248e093
to
054f187
Compare
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: alacuku, FedeDP 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 |
|
LGTM label has been added. Git tree hash: bb9a9c692640a32db52a63023d9218a68a452837
|
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.
What type of PR is this?
/kind feature
Any specific area of the project related to this PR?
/area cli
/area tests
What this PR does / why we need it:
It's a complete rework of the output system. The scope is to introduce a consistent
loggingandformattingacross all falcoctl commands. It is done by usingstructured logging, but at the same time objects asspinnersandprogress barsare rendered during the operations but removed once done. Furthermore the new logging prints also thetimestampswhich is handy for thefaloctl artifact followcommand. It allows to know when a specific actions has been performed and easies the troubleshooting problems when they occurs.The old flags
--verboseand--disable-stylinghave been deprecated and substituted with--log-leveland--log-formatflags. It will be completely removed in one of the next releases of falcoctl.The new log levels supported in falcoctl are:
The default value is
Info.The new formats are
color, text and json.By setting the
--verboseflag is equivalent to using--log-level debugand the--disable-stylingis equivalent to--log-format jsonHere are some examples of the new output in falcoctl:
Default logging:
Same as above but in
json format:❯ falcoctl artifact install k8saudit --log-format json {"level":"INFO","msg":"Resolving dependencies ...","timestamp":"2023-10-25 12:09:10"} {"level":"INFO","msg":"Installing artifacts","refs":["ghcr.io/falcosecurity/plugins/plugin/k8saudit:latest"],"timestamp":"2023-10-25 12:09:11"} {"level":"INFO","msg":"Preparing to pull artifact","ref":"ghcr.io/falcosecurity/plugins/plugin/k8saudit:latest","timestamp":"2023-10-25 12:09:11"} {"level":"INFO","msg":"Pulling layer 75ff683c3b71","timestamp":"2023-10-25 12:09:11"} {"level":"INFO","msg":"Pulling layer e2908ebf2c03","timestamp":"2023-10-25 12:09:12"} {"level":"INFO","msg":"Pulling layer bebd560a926b","timestamp":"2023-10-25 12:09:13"} {"digest":"ghcr.io/falcosecurity/plugins/plugin/k8saudit@sha256:230dfdc0e1d331c5085f3f4c860838dcfc27f9aca8d615ce7d771ace4b621dc6","level":"INFO","msg":"Verifying signature for artifact","timestamp":"2023-10-25 12:09:13"} {"level":"INFO","msg":"Signature successfully verified!","timestamp":"2023-10-25 12:09:14"} {"file":"k8saudit-0.6.1-linux-x86_64.tar.gz","level":"INFO","msg":"Extracting and installing artifact","timestamp":"2023-10-25 12:09:14","type":"plugin"} {"digest":"sha256:bebd560a926b9f6234561363ae082daa740abb68b9d6da19bdaf16c13e795a34","directory":"/usr/share/falco/plugins","level":"INFO","msg":"Artifact successfully installed","name":"ghcr.io/falcosecurity/plugins/plugin/k8saudit:latest","timestamp":"2023-10-25 12:09:14","type":"plugin"}Which issue(s) this PR fixes:
Fixes #
Special notes for your reviewer: