Add logger adapter with bugbot_rule context (#2753)

Author: suhaibmujahid

bugbot/__init__.py

@@ -55,19 +55,29 @@ def get_version():
     raise
 
 
-path = utils.get_config("common", "log")
-
-logger = logging.getLogger()
-logger.setLevel(logging.INFO)
-handler = logging.StreamHandler(sys.stdout)
-formatter = logging.Formatter("%(asctime)s - %(levelname)s - %(message)s")
-handler.setFormatter(formatter)
-logger.addHandler(handler)
-
-error = logging.FileHandler(path)
-error.setLevel(logging.ERROR)
-error.setFormatter(formatter)
-logger.addHandler(error)
+logger_extra = {"bugbot_rule": None}
+
+
+def create_logger(logger_extra):
+    path = utils.get_config("common", "log")
+    formatter = logging.Formatter("%(asctime)s - %(levelname)s - %(message)s")
+
+    logger = logging.getLogger()
+    logger.setLevel(logging.INFO)
+
+    handler = logging.StreamHandler(sys.stdout)
+    handler.setFormatter(formatter)
+    logger.addHandler(handler)
+
+    error = logging.FileHandler(path)
+    error.setLevel(logging.ERROR)
+    error.setFormatter(formatter)
+    logger.addHandler(error)
+
+    return logging.LoggerAdapter(logger, logger_extra)
+
+
+logger = create_logger(logger_extra)
 
 
 def _handle_uncaught_exception(exc_type, exc_value, exc_traceback):

bugbot/bzcleaner.py

@@ -17,7 +17,7 @@
 from libmozdata import utils as lmdutils
 from libmozdata.bugzilla import Bugzilla
 
-from bugbot import db, logger, mail, utils
+from bugbot import db, logger, logger_extra, mail, utils
 from bugbot.cache import Cache
 from bugbot.nag_me import Nag
 
@@ -842,6 +842,8 @@ def get_args_parser(self):
 
     def run(self):
         """Run the rule"""
+        logger_extra["bugbot_rule"] = self.name()
+
         args = self.get_args_parser().parse_args()
         self.parse_custom_arguments(args)
         date = "" if self.ignore_date() else args.date