logging: add config for trace loggers and logging directory #118
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
onerandomusername
added
s: needs review
onerandomusername
force-pushed
the
trace-loggers
branch
2 times, most recently
from
0847c18
to
7001b7f
Compare
Codecov Report
@@ Coverage Diff @@
## main #118 +/- ##
==========================================
- Coverage 70.90% 70.28% -0.63%
==========================================
Files 33 33
Lines 1619 1669 +50
Branches 199 207 +8
==========================================
+ Hits 1148 1173 +25
- Misses 439 461 +22
- Partials 32 35 +3
Continue to review full report at Codecov.
|
onerandomusername
force-pushed
the
trace-loggers
branch
2 times, most recently
from
fc3611c
to
97f349a
Compare
- allow configuring loggers and their specified levels
Some loggers can get spammy when debugging, this allows
turning them down, or setting other loggers to lower levels than the root
To use, set a MODMAIL_{level}_LOGGERS environment variable, delimiting
the loggers with `,`
Valid levels are all of the valid levels for logging, as follows
trace, debug, info, notice, warning, error, critical
- add support for configuring the file logging directory
The directory for logging files was fully dependent on the current
working directory
This caused my environment to be littered with logging directories
The solution to this was to continue to use the current working
directory, unless the parent directory of the bot is also a parent of
the cwd, in which case the bot parent directory is used for creating
the logging directory.
In addition, `MODMAIL_LOGGING_DIRECTORY` has been added as an override
environment variable. Setting it will use that directory for logging.
onerandomusername
force-pushed
the
trace-loggers
branch
from
97f349a
to
9c40668
Compare
modmail/log.py
Outdated
| This is applied for every logging level. | ||
| """ | ||
| env_vars = _get_env() | ||
| fmt_key = "MODMAIL_{level}_LOGGERS" |
There was a problem hiding this comment.
TBH I'm not sure if this should be this format, or if MODMAIL_LOGGERS_{level} makes more sense since the variable is now more hierarchical.
There was a problem hiding this comment.
I'm going to reverse this format, actually.
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.
Some loggers can get spammy when debugging, this allows
turning them down, or setting other loggers to lower levels than the root
To use, set a MODMAIL_{level}_LOGGERS environment variable, delimiting
the loggers with
,Valid levels are all of the valid levels for logging, as follows
trace, debug, info, notice, warning, error, critical
The directory for logging files was fully dependent on the current
working directory
This caused my environment to be littered with logging directories
The solution to this was to continue to use the current working
directory, unless the parent directory of the bot is also a parent of
the cwd, in which case the bot parent directory is used for creating
the logging directory.
In addition,
MODMAIL_LOGGING_DIRECTORYhas been added as an overrideenvironment variable. Setting it will use that directory for logging.