Remove usage info from log output#1242
Merged
Merged
Conversation
Contributor
|
I think we should also set without with
I think it makes sense in the root command so that every subcommand inherits those values. |
fbc3311 to
4d6a7e7
Compare
sjberman
approved these changes
Nov 13, 2023
kate-osborn
approved these changes
Nov 13, 2023
miledxz
added a commit
to miledxz/nginx-gateway-fabric
that referenced
this pull request
Jan 14, 2025
Remove usage info from log output. Problem: When a critical error occurs at startup, usage information for the binary is dumped into the log output. Solution: Set SilenceUsage and SilenceErrors to true in the root cobra.Command.
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
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.
Remove usage info from log output.
Problem: When a critical error occurs at startup, usage information for the binary is dumped into the log output.
Solution: Set
SilenceUsageandSilenceErrorsto true in the rootcobra.Command. This problem was discussed here in an older discussion on cobra's github page.Testing: Manually tested these cases (usage is there before the change and is no longer there after the change):
docker restart kind-control-planewhich displayed the error recorded in a non-functional test here.Please focus on (optional): Should I set SilenceUsage in
createProvisionerModeCommand? Currently its just in the StaticModeCommand. Also, as described in the discussion linked above, it mentions possibly settingSilenceUsagein the root command, should I instead put that increateRootCommand?Closes #1105
Checklist
Before creating a PR, run through this checklist and mark each as complete.