Switch to top-level loggers

Author: paravoid

ircstream/ircserver.py

@@ -30,6 +30,8 @@
 
 from ._version import __version__
 
+logger = structlog.get_logger()
+
 
 class IRCNumeric(enum.Enum):
     """Base class for IRC numeric enums."""
@@ -200,13 +202,12 @@ class IRCClient:
     the client by dispatching them to the ``handle_`` methods.
     """
 
-    log = structlog.get_logger("ircstream.client")
-
     def __init__(self, server: IRCServer, reader: asyncio.StreamReader, writer: asyncio.StreamWriter) -> None:
         self.server = server
         self.reader = reader
         self.writer = writer
 
+        self.log = logger.new()
         self.signon = datetime.datetime.now(tz=datetime.timezone.utc)
         self.last_heard = self.signon
         self.ping_sent = False
@@ -224,7 +225,7 @@ async def connect(self) -> None:
         if self.host.startswith("::ffff:"):
             self.host = self.host[len("::ffff:") :]
 
-        self.log.new(ip=self.host, port=self.port)
+        self.log = self.log.bind(ip=self.host, port=self.port)
         self.log.info("Client connected")
         self.server.metrics["clients"].inc()
         self._periodic_ping_task = asyncio.create_task(self._periodic_ping())

ircstream/main.py

@@ -29,6 +29,8 @@
 from .prometheus import PrometheusServer
 from .rc2udp import RC2UDPServer
 
+logger = structlog.get_logger()
+
 
 def parse_args(argv: Sequence[str] | None) -> argparse.Namespace:
     """Parse and return the parsed command line arguments."""
@@ -83,7 +85,6 @@ def configure_logging(log_format: str = "plain") -> None:
 
 async def start_servers(config: configparser.ConfigParser) -> None:
     """Start all servers in asyncio tasks or threads and then busy-loop."""
-    log = structlog.get_logger("ircstream.main")
     loop = asyncio.get_running_loop()
 
     try:
@@ -92,14 +93,14 @@ async def start_servers(config: configparser.ConfigParser) -> None:
             irc_coro = ircserver.serve()
             irc_task = asyncio.create_task(irc_coro)
         else:
-            log.critical('Invalid configuration, missing section "irc"')
+            logger.critical('Invalid configuration, missing section "irc"')
             raise SystemExit(-1)
 
         if "rc2udp" in config:
             rc2udp_coro = RC2UDPServer(config["rc2udp"], ircserver).serve()
             rc2udp_task = asyncio.create_task(rc2udp_coro)  # noqa: F841 pylint: disable=unused-variable
         else:
-            log.warning("RC2UDP is not enabled in the config; server usefulness may be limited")
+            logger.warning("RC2UDP is not enabled in the config; server usefulness may be limited")
 
         if "prometheus" in config:
             prom_server = PrometheusServer(config["prometheus"], ircserver.metrics_registry)
@@ -108,7 +109,7 @@ async def start_servers(config: configparser.ConfigParser) -> None:
 
         await asyncio.wait_for(irc_task, timeout=None)  # run forever
     except OSError as exc:
-        log.critical(f"System error: {exc.strerror}", errno=errno.errorcode[exc.errno])
+        logger.critical(f"System error: {exc.strerror}", errno=errno.errorcode[exc.errno])
         raise SystemExit(-2) from exc
 
 
@@ -119,19 +120,18 @@ def run(argv: Sequence[str] | None = None) -> None:
     configure_logging(options.log_format)
     # only set e.g. INFO or DEBUG for our own loggers
     structlog.get_logger("ircstream").setLevel(options.log_level)
-    log = structlog.get_logger("ircstream.main")
-    log.info("Starting IRCStream", config_file=str(options.config_file), version=__version__)
+    logger.info("Starting IRCStream", config_file=str(options.config_file), version=__version__)
 
     config = configparser.ConfigParser(strict=True)
     try:
         with options.config_file.open(encoding="utf-8") as config_fh:
             config.read_file(config_fh)
     except OSError as exc:
-        log.critical(f"Cannot open configuration file: {exc.strerror}", errno=errno.errorcode[exc.errno])
+        logger.critical(f"Cannot open configuration file: {exc.strerror}", errno=errno.errorcode[exc.errno])
         raise SystemExit(-1) from exc
     except configparser.Error as exc:
         msg = repr(exc).replace("\n", " ")  # configparser exceptions sometimes include newlines
-        log.critical(f"Invalid configuration, {msg}")
+        logger.critical(f"Invalid configuration, {msg}")
         raise SystemExit(-1) from exc
 
     try:

ircstream/prometheus.py

@@ -21,11 +21,12 @@
 import prometheus_client
 import structlog
 
+logger = structlog.get_logger()
+
 
 class PrometheusServer(http.server.ThreadingHTTPServer):
     """A Prometheus HTTP server."""
 
-    log = structlog.get_logger("ircstream.prometheus")
     daemon_threads = True
     allow_reuse_address = True
 
@@ -41,7 +42,7 @@ def __init__(
         super().__init__((listen_address, listen_port), prometheus_client.MetricsHandler.factory(registry))
         # update address/port based on what bind() returned
         self.address, self.port = str(self.server_address[0]), self.server_address[1]
-        self.log.info("Listening for Prometheus HTTP", listen_address=self.address, listen_port=self.port)
+        logger.info("Listening for Prometheus HTTP", listen_address=self.address, listen_port=self.port)
 
     def server_bind(self) -> None:
         """Bind to an IP address.

ircstream/rc2udp.py

@@ -22,12 +22,12 @@
 
     from .ircserver import IRCServer
 
+logger = structlog.get_logger()
+
 
 class RC2UDPHandler(asyncio.Protocol):
     """A handler implementing the RC2UDP protocol, as used by MediaWiki."""
 
-    log = structlog.get_logger("ircstream.rc2udp")
-
     def __init__(self, server: RC2UDPServer) -> None:
         self.server = server
         self.running_tasks: set[asyncio.Task[Any]] = set()
@@ -43,7 +43,7 @@ def datagram_received(self, data: bytes, _: tuple[str, int]) -> None:
             self.server.ircserver.metrics["errors"].labels("rc2udp-parsing").inc()
             return
 
-        self.log.debug("Broadcasting message", channel=channel, message=text)
+        logger.debug("Broadcasting message", channel=channel, message=text)
         task = asyncio.create_task(self.server.ircserver.broadcast(channel, text))
         self.running_tasks.add(task)
         task.add_done_callback(self.running_tasks.discard)
@@ -66,4 +66,4 @@ async def serve(self) -> None:
         transport, _ = await loop.create_datagram_endpoint(lambda: RC2UDPHandler(self), local_addr=local_addr)
         local_addr = transport.get_extra_info("sockname")[:2]
         self.address, self.port = local_addr  # update address/port based on what bind() returned
-        self.log.info("Listening for RC2UDP broadcast", listen_address=self.address, listen_port=self.port)
+        logger.info("Listening for RC2UDP broadcast", listen_address=self.address, listen_port=self.port)