Added a line to the documentation to further explain the use of logconfig_dict. #2431
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
tilgovi
reviewed
Feb 16, 2021
| @@ -304,6 +304,8 @@ older file configuration format. | |||
|
|
|||
| Format: https://docs.python.org/3/library/logging.config.html#logging.config.dictConfig | |||
|
|
|||
| For more context you can look at the default configuration dictionary for logging, which can be found at ``gunicorn.glogging.CONFIG_DEFAULTS``. | |||
There was a problem hiding this comment.
This is great. I wonder if there's a way we could actually embed CONFIG_DEFAULTS here as the default value in the documentation, or if we could link to it.
There was a problem hiding this comment.
Good question. We can of course link to glogging but I don't know if there is any way to auto-link to a variable in the file.
There was a problem hiding this comment.
It is possible to link directly to a linenumber though. But a commit could then break the location. And locking to a commit hash is also not preferable I believe...
tilgovi
approved these changes
Feb 16, 2021
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 usage of logconifg_dict can be confusing, not only since there is not a clear example on the site now, but also since the documentation of python's dictConfig is minimal. And since you need to know about the specific loggers that gunicorn uses to configure them properly.