4903: Diffviewer module should use named logging


There are numerous instances of files under reviewboard/reviewboard/diffviewer/ using this pattern:

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:

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.

#1 mconley
  • +EasyFix
#2 maubin

Working on this

#3 david

Fixed for release-5.0.x (0ded004). This will ship in 5.0.

  • -New