fix: IPFS_LOG_LEVEL is actually deprecated, help text updated #10694
+23
−15
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
SgtPooki
commented
Feb 4, 2025
Comment on lines
+229
to
+232
| ipfsLogLevel, _ := logging.LevelFromString(os.Getenv("IPFS_LOGGING")) // IPFS_LOGGING is deprecated | ||
| goLogLevel, _ := logging.LevelFromString(os.Getenv("GOLOG_LOG_LEVEL")) | ||
|
|
||
| if debug || goLogLevel == logging.LevelDebug || ipfsLogLevel == logging.LevelDebug { |
There was a problem hiding this comment.
based on the documentation at https://github.com/ipfs/go-log#usage I think this should do what we want (support non-deprecated env var, still allow old one..)
This change also corrects functionality to where export GOLOG_LOG_LEVEL="debug,subsystem=info" will actually enable debug logging, instead of potentially not.
AFAIK, "debug,system=info" == "debug" would have previously returned false. Idk if that was intended or not.
gammazero
approved these changes
Feb 4, 2025
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.
The
ipfs log --helptext is updated to recommend the correct environment variable, and the debug logging check is more robust when checking if debug logging should be enabled.When running
ipfs log --helpI noticed two environment variables I was unfamiliar with. This PR updates every place where IPFS_LOG_LEVEL was used, to GOLOG_LOG_LEVEL, and IPFS_LOG_FMT to GOLOG_LOG_FMT, but does not completely "sunset" the deprecated environment variables.The
IPFS_LOG_LEVELenvironment variable was still in use in the code, so I think fully removing it at this point would be premature, let me know if you think otherwise.NOTE: these env vars were documented as deprecated in #8833