------------------------------------------------------------------------------
To reply, visit https://hellosplat.com/s/beanbag/tickets/4909/
------------------------------------------------------------------------------
New ticket #4909 by mconley
For Beanbag, Inc. > Review Board
Status: New
Tags: Priority:Medium, Type:Defect
------------------------------------------------------------------------------
SCMTools module should use named logging
==============================================================================
There are numerous instances of files under `reviewboard/reviewboard/scmtools/`
using this pattern:
```python
import logging
# ...
logging.warning("Some warning message")
logging.error("Some error message")
logging.exception("Handled some exception")
# etc
```
etc. While this is useful, these logging messages can be made more useful if
they are "named", meaning that the logging mechanism automatically includes
information about the module where the logging message came from which can be
handy when diagnosing problems from logs.
Named logging looks like this:
```python
import logging
logger = logging.getLogger(__name__)
# ^-- make sure to do this at the top of the script execution scope so that
`logger` is available throughout the script.
#...
logger.warning("This is a warning to a named logger")
logger.error("This is a error to a named logger")
logger.exception("This is a exception to a named logger")
# etc
```
The directory in question uses _some_ named logging. The goal here is to
replace the other usages to use named logging. The log messages themselves
shouldn't change, and there's no need to add new log messages - just convert
the ones that exist in this module directory to named logging.
------------------------------------------------------------------------------
--
You received this message because you are subscribed to the Google Groups
"reviewboard-issues" group.
To unsubscribe from this group and stop receiving emails from it, send an email
to [email protected].
To view this discussion on the web visit
https://groups.google.com/d/msgid/reviewboard-issues/20210121233632.32238.88990%40ip-10-1-54-209.ec2.internal.
