logging_revamp: replace modules' logger name

lib/apt_news.py

@@ -8,8 +8,6 @@
 from uaclient.config import UAConfig
 from uaclient.daemon import setup_logging
 
-uaclient_logger = logging.getLogger("uaclient")
-
 
 def main(cfg: UAConfig):
     if not cfg.apt_news:
@@ -28,13 +26,11 @@ def main(cfg: UAConfig):
         logging.INFO,
         logging.DEBUG,
         defaults.CONFIG_DEFAULTS["log_file"],
-        logger=uaclient_logger,
     )
     cfg = UAConfig()
     setup_logging(
         logging.INFO,
         logging.DEBUG,
-        log_file=cfg.log_file,
-        logger=uaclient_logger,
+        cfg.log_file,
     )
     main(cfg)

lib/auto_attach.py

@@ -31,8 +31,7 @@
 )
 from uaclient.files import state_files
 
-uaclient_logger = logging.getLogger("uaclient")
-LOG = logging.getLogger("uaclient.lib.auto_attach")
+LOG = logging.getLogger("ubuntupro.lib.auto_attach")
 
 try:
     import cloudinit.stages as ci_stages  # type: ignore
@@ -108,13 +107,11 @@ def main(cfg: UAConfig):
         logging.INFO,
         logging.DEBUG,
         defaults.CONFIG_DEFAULTS["log_file"],
-        logger=uaclient_logger,
     )
     cfg = UAConfig()
     setup_logging(
         logging.INFO,
         logging.DEBUG,
-        log_file=cfg.log_file,
-        logger=uaclient_logger,
+        cfg.log_file,
     )
     sys.exit(main(cfg))

lib/daemon.py

@@ -12,8 +12,7 @@
     setup_logging,
 )
 
-LOG = logging.getLogger("uaclient.lib.daemon")
-uaclient_logger = logging.getLogger("uaclient")
+LOG = logging.getLogger("ubuntupro.lib.daemon")
 
 
 def main() -> int:
@@ -31,12 +30,10 @@ def main() -> int:
     # Make sure the ua-daemon logger does not generate double logging
     # by propagating to the root logger
     # The root logger should only log errors to the daemon log file
-    # TODO: is this okay? root_logger("uaclient")
     setup_logging(
         logging.CRITICAL,
         logging.ERROR,
-        log_file=cfg.daemon_log_file,
-        logger=uaclient_logger,
+        cfg.daemon_log_file,
     )
 
     LOG.debug("daemon starting")

lib/esm_cache.py

@@ -7,8 +7,7 @@
 from uaclient.config import UAConfig
 from uaclient.daemon import setup_logging
 
-LOG = logging.getLogger("uaclient.lib.esm_cache")
-uaclient_logger = logging.getLogger("uaclient")
+LOG = logging.getLogger("ubuntupro.lib.esm_cache")
 
 
 def main(cfg: UAConfig) -> None:
@@ -24,13 +23,11 @@ def main(cfg: UAConfig) -> None:
         logging.INFO,
         logging.DEBUG,
         defaults.CONFIG_DEFAULTS["log_file"],
-        logger=uaclient_logger,
     )
     cfg = UAConfig()
     setup_logging(
         logging.INFO,
         logging.DEBUG,
-        log_file=cfg.log_file,
-        logger=uaclient_logger,
+        cfg.log_file,
     )
     main(cfg)

lib/patch_status_json.py

@@ -21,7 +21,7 @@
 from uaclient import system, util
 from uaclient.cli import setup_logging
 
-LOG = logging.getLogger("uaclient.lib.patch_status_json")
+LOG = logging.getLogger("ubuntupro.lib.patch_status_json")
 
 
 def patch_status_json_schema_0_1(status_file: str):

lib/reboot_cmds.py

@@ -31,7 +31,7 @@
 from uaclient.entitlements.fips import FIPSEntitlement
 from uaclient.files import notices, state_files
 
-LOG = logging.getLogger("uaclient.lib.reboot_cmds")
+LOG = logging.getLogger("ubuntupro.lib.reboot_cmds")
 
 
 def fix_pro_pkg_holds(cfg: config.UAConfig):

lib/timer.py

@@ -19,7 +19,7 @@
 from uaclient.timer.update_contract_info import update_contract_info
 from uaclient.timer.update_messaging import update_motd_messages
 
-LOG = logging.getLogger("uaclient.lib.timer")
+LOG = logging.getLogger("ubuntupro.lib.timer")
 UPDATE_MESSAGING_INTERVAL = 21600  # 6 hours
 METERING_INTERVAL = 14400  # 4 hours
 UPDATE_CONTRACT_INFO_INTERVAL = 86400  # 24 hours
@@ -183,6 +183,7 @@ def run_jobs(cfg: UAConfig, current_time: datetime):
         logging.CRITICAL,
         logging.DEBUG,
         defaults.CONFIG_DEFAULTS["timer_log_file"],
+        logger=LOG,
     )
     cfg = UAConfig()
     current_time = datetime.now(timezone.utc)
@@ -192,7 +193,10 @@ def run_jobs(cfg: UAConfig, current_time: datetime):
         logging.CRITICAL,
         logging.DEBUG,
         log_file=cfg.timer_log_file,
+        logger=LOG,
     )
+    # Make sure the ua-timer logger does not generate double logging
+    LOG.propagate = False
     # The root logger should log any error to the timer log file
     setup_logging(logging.CRITICAL, logging.ERROR, log_file=cfg.timer_log_file)
 

uaclient/actions.py

@@ -24,7 +24,7 @@
 )
 from uaclient.files.state_files import timer_jobs_state_file
 
-LOG = logging.getLogger(__name__)
+LOG = logging.getLogger(util.replace_top_level_logger_name(__name__))
 
 
 UA_SERVICES = (
@@ -231,7 +231,7 @@ def collect_logs(cfg: config.UAConfig, output_dir: str):
                 content,
             )
         except Exception as e:
-            logging.warning(
+            LOG.warning(
                 "Failed to collect user log file: %s\n%s", log_file, str(e)
             )
 

uaclient/api/__init__.py

@@ -1,4 +1,4 @@
 import logging
 
 # setup null handler for all API endpoints
-logging.getLogger("uaclient").addHandler(logging.NullHandler())
+logging.getLogger("ubuntupro").addHandler(logging.NullHandler())

uaclient/api/api.py

@@ -38,7 +38,6 @@
 def call_api(
     endpoint_path: str, options: List[str], cfg: UAConfig
 ) -> APIResponse:
-    # setup null handler for all API endpoints
 
     if endpoint_path not in VALID_ENDPOINTS:
         return error_out(

uaclient/apt.py

@@ -14,7 +14,7 @@
 import apt  # type: ignore
 import apt_pkg  # type: ignore
 
-from uaclient import event_logger, exceptions, gpg, messages, system
+from uaclient import event_logger, exceptions, gpg, messages, system, util
 from uaclient.defaults import ESM_APT_ROOTDIR
 
 APT_HELPER_TIMEOUT = 60.0  # 60 second timeout used for apt-helper call
@@ -56,7 +56,7 @@
 APT_RETRIES = [1.0, 5.0, 10.0]
 
 event = event_logger.get_event_logger()
-LOG = logging.getLogger(__name__)
+LOG = logging.getLogger(util.replace_top_level_logger_name(__name__))
 
 
 @enum.unique

uaclient/apt_news.py

@@ -25,7 +25,7 @@
     get_contract_expiry_status,
 )
 
-LOG = logging.getLogger(__name__)
+LOG = logging.getLogger(util.replace_top_level_logger_name(__name__))
 
 
 class AptNewsMessageSelectors(DataObject):
@@ -169,7 +169,7 @@ def fetch_aptnews_json(cfg: UAConfig):
 def fetch_and_process_apt_news(cfg: UAConfig) -> Optional[str]:
     news_dict = fetch_aptnews_json(cfg)
     msg = select_message(cfg, news_dict.get("messages", []))
-    logging.debug("using msg: %r", msg)
+    LOG.debug("using msg: %r", msg)
     if msg is not None:
         return "\n".join(msg.lines)
     return None
@@ -227,6 +227,6 @@ def update_apt_news(cfg: UAConfig):
             state_files.apt_news_contents_file.delete()
             state_files.apt_news_raw_file.delete()
     except Exception as e:
-        logging.debug("something went wrong while processing apt_news: %r", e)
+        LOG.debug("something went wrong while processing apt_news: %r", e)
         state_files.apt_news_contents_file.delete()
         state_files.apt_news_raw_file.delete()

uaclient/cli.py

@@ -100,8 +100,7 @@
 )
 
 event = event_logger.get_event_logger()
-uaclient_logger = logging.getLogger("uaclient")
-LOG = logging.getLogger(__name__)
+LOG = logging.getLogger(util.replace_top_level_logger_name(__name__))
 
 
 class UAArgumentParser(argparse.ArgumentParser):
@@ -1876,7 +1875,7 @@ def _warn_about_output_redirection(cmd_args) -> None:
     ):
         if hasattr(cmd_args, "format") and cmd_args.format in ("json", "yaml"):
             return
-        logging.warning(
+        LOG.warning(
             messages.WARNING_HUMAN_READABLE_OUTPUT.format(
                 command=cmd_args.command
             )
@@ -1901,18 +1900,20 @@ def setup_logging(console_level, log_level, log_file=None, logger=None):
         log_level = log_level.upper()
 
     console_formatter = util.LogFormatter()
-    uaclient_logger.setLevel(log_level)
-    uaclient_logger.addFilter(pro_log.RedactionFilter())
+    if not logger:
+        logger = logging.getLogger("ubuntupro")
+    logger.setLevel(log_level)
+    logger.addFilter(pro_log.RedactionFilter())
 
     # Clear all handlers, so they are replaced for this logger
-    uaclient_logger.handlers = []
+    logger.handlers = []
 
     # Setup console logging
     console_handler = logging.StreamHandler(sys.stderr)
     console_handler.setFormatter(console_formatter)
     console_handler.setLevel(console_level)
-    console_handler.set_name("ua-console")  # Used to disable console logging
-    uaclient_logger.addHandler(console_handler)
+    console_handler.set_name("upro-console")  # Used to disable console logging
+    logger.addHandler(console_handler)
 
     log_file_path = pathlib.Path(log_file)
 
@@ -1924,8 +1925,8 @@ def setup_logging(console_level, log_level, log_file=None, logger=None):
     file_handler = logging.FileHandler(log_file)
     file_handler.setFormatter(JsonArrayFormatter())
     file_handler.setLevel(log_level)
-    file_handler.set_name("ua-file")
-    uaclient_logger.addHandler(file_handler)
+    file_handler.set_name("upro-file")
+    logger.addHandler(file_handler)
 
 
 def set_event_mode(cmd_args):

uaclient/clouds/aws.py

@@ -19,7 +19,7 @@
 AWS_TOKEN_PUT_HEADER = "X-aws-ec2-metadata-token"
 AWS_TOKEN_REQ_HEADER = AWS_TOKEN_PUT_HEADER + "-ttl-seconds"
 
-LOG = logging.getLogger(__name__)
+LOG = logging.getLogger(util.replace_top_level_logger_name(__name__))
 
 
 class UAAutoAttachAWSInstance(AutoAttachCloudInstance):

uaclient/clouds/azure.py

@@ -5,7 +5,7 @@
 from uaclient import exceptions, http, system, util
 from uaclient.clouds import AutoAttachCloudInstance
 
-LOG = logging.getLogger("pro.clouds.azure")
+LOG = logging.getLogger("ubuntupro.clouds.azure")
 
 IMDS_BASE_URL = "http://169.254.169.254/metadata/"
 

uaclient/clouds/gcp.py

@@ -7,7 +7,7 @@
 from uaclient import exceptions, http, messages, system, util
 from uaclient.clouds import AutoAttachCloudInstance
 
-LOG = logging.getLogger("pro.clouds.gcp")
+LOG = logging.getLogger("ubuntupro.clouds.gcp")
 
 TOKEN_URL = (
     "http://metadata/computeMetadata/v1/instance/service-accounts/"

uaclient/clouds/identity.py

@@ -3,10 +3,10 @@
 from functools import lru_cache
 from typing import Dict, Optional, Tuple, Type  # noqa: F401
 
-from uaclient import clouds, exceptions, system
+from uaclient import clouds, exceptions, system, util
 from uaclient.config import apply_config_settings_override
 
-LOG = logging.getLogger(__name__)
+LOG = logging.getLogger(util.replace_top_level_logger_name(__name__))
 
 CLOUD_TYPE_TO_TITLE = {
     "aws": "AWS",

uaclient/config.py

@@ -31,7 +31,7 @@
 from uaclient.files.notices import Notice
 from uaclient.yaml import safe_load
 
-LOG = logging.getLogger(__name__)
+LOG = logging.getLogger(util.replace_top_level_logger_name(__name__))
 
 PRIVATE_SUBDIR = "private"
 MERGE_ID_KEY_MAP = {

uaclient/conftest.py

@@ -108,7 +108,7 @@ def _func():
 
     except LookupError:
         # If the caplog fixture isn't available, shim something in ourselves
-        root = logging.getLogger("uaclient")
+        root = logging.getLogger("ubuntupro")
         root.propagate = False
         root.setLevel(log_level)
         handler = logging.StreamHandler(io.StringIO())
@@ -135,13 +135,13 @@ def clear_handlers():
 def logging_sandbox():
     # Monkeypatch a replacement root logger, so that our changes to logging
     # configuration don't persist outside of the test
-    uaclient_logger = logging.getLogger("uaclient")
-    uaclient_logger.setLevel(logging.WARNING)
+    upro_logger = logging.getLogger("ubuntupro")
+    upro_logger.setLevel(logging.WARNING)
 
-    with mock.patch.object(logging, "root", uaclient_logger):
-        with mock.patch.object(logging.Logger, "root", uaclient_logger):
+    with mock.patch.object(logging, "root", upro_logger):
+        with mock.patch.object(logging.Logger, "root", upro_logger):
             with mock.patch.object(
-                logging.Logger, "manager", logging.Manager(uaclient_logger)
+                logging.Logger, "manager", logging.Manager(upro_logger)
             ):
                 yield
 

uaclient/contract.py

@@ -48,7 +48,7 @@
 }
 
 event = event_logger.get_event_logger()
-LOG = logging.getLogger(__name__)
+LOG = logging.getLogger(util.replace_top_level_logger_name(__name__))
 
 
 class UAContractClient(serviceclient.UAServiceClient):
@@ -230,7 +230,6 @@ def update_activity_token(self):
         # a full `activityInfo` object which belongs at the root of
         # `machine-token.json`
         if response.json_dict:
-
             machine_token = self.cfg.machine_token
             # The activity information received as a response here
             # will not provide the information inside an activityInfo