Standardize logs #1053
Merged
Standardize logs #1053
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
jcudit
approved these changes
Feb 12, 2022
kfcampbell
added a commit
to kfcampbell/terraform-provider-github
that referenced
this pull request
Jul 26, 2022
* First batch of changes * Another batch of changes * More changes, maybe fix build * More log cleanup * Final changes * Fix one additional error message
kazaker
pushed a commit
to auto1-oss/terraform-provider-github
that referenced
this pull request
Dec 28, 2022
* First batch of changes * Another batch of changes * More changes, maybe fix build * More log cleanup * Final changes * Fix one additional error message
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.
Frequently while working with the project, I find the logs messy and unwieldy to work with. I end up having to wade through a lot of unrelated logs to find interesting information, and our log level practices are all over the place.
This PR represents my best effort to standardize on Dave Cheney's log levels best practices. It removes all log levels except for two:
INFOandDEBUG, which is information intended for the user and the developer, respectively. I've keptINFO-level logs to things like auth logic and when we make state correction for external changes.DEBUG-level logs tend to describe tricky logic, such as GitHub webhook state migration and commit lookup. In many cases, I've removed them entirely. In particular, I've removed logs that tend to describe what the ensuing function does. Those may be trivially added back by the developer when necessary, and our function/variable naming is good enough in my opinion that the log statements don't need to be replaced by comments.My hope is this makes the provider a bit cleaner and easier to work with.