Issues/180: make naz.Client.logger to be a python logging.Handler

CHANGELOG.md

@@ -5,6 +5,7 @@ most recent version is listed first.
 ## **version:** v0.7.4
 - Fix a bug that prevented `enquire_link` and `deliver_sm` from been sent: https://github.com/komuw/naz/pull/179  
 - Enforce `naz` message protocol in code : https://github.com/komuw/naz/pull/179
+- make make `naz.Client.logger` to be a python `logging.Handler`: https://github.com/komuw/naz/pull/181
 
 
 ## **version:** v0.7.3

README.md

@@ -152,7 +152,7 @@ run:
 ```              
 
 **NB:**      
-(a) For more information about the `naz` config file, consult the [documentation here](https://komuw.github.io/naz/client.html)             
+(a) The ```naz`` config file(ie, the dotted path we pass in to ``naz-cli --client``) is any python file that has a `naz.Client instance <https://komuw.github.io/naz/client.html>`_ declared in it.                
 (b) More [examples can be found here](https://github.com/komuw/naz/tree/master/examples). As an example, start the SMSC simulator(`docker-compose up`) then in another terminal run, `naz-cli --client examples.example_config.client`
 
 To see help:
@@ -198,9 +198,13 @@ So, for example if you wanted to annotate all log-events with a release version
 ```python
 import naz
 
+logger = naz.log.SimpleLogger(
+                "naz.client",
+                log_metadata={ "environment": "production", "release": "v5.6.8"}
+            )
 cli = naz.Client(
     ...
-    log_metadata={ "environment": "production", "release": "canary"},
+    logger=logger,
 )
 ```
 and then these will show up in all log events.             

benchmarks/app.py

@@ -16,11 +16,11 @@
     smsc_port=2775,
     system_id="smppclient1",
     password=os.environ["SMSC_PASSWORD"],
-    loglevel="DEBUG",
-    log_metadata={"project": "naz_benchmarks"},
     broker=MyRedisBroker(),
     hook=BenchmarksHook(),
-    logger=BenchmarksLogger("naz.client"),
+    logger=BenchmarksLogger(
+        logger_name="naz.benchmarks", level="DEBUG", log_metadata={"project": "naz_benchmarks"},
+    ),
     socket_timeout=15.00,
     enquire_link_interval=80.00,
     address_range="^{0}".format(

benchmarks/my_logger.py

@@ -1,11 +1,8 @@
 import os
 import errno
-import json
 import typing
 import logging
 
-import naz
-
 
 def makelog(log_directory="/usr/src/nazLog", log_file="naz_log_file"):
     log_file = os.path.join(log_directory, log_file)
@@ -35,43 +32,17 @@ def makelog(log_directory="/usr/src/nazLog", log_file="naz_log_file"):
 log_file = makelog()
 
 
-class MyLogAdapter(naz.log._NazLoggingAdapter):
-    def process(self, msg, kwargs):
-        timestamp = self.formatTime()
-        if isinstance(msg, str):
-            merged_msg = "{0} {1} {2}".format(timestamp, msg, self.extra)
-            if self.extra == {}:
-                merged_msg = "{0} {1}".format(timestamp, msg)
-            return self._dumps(merged_msg), kwargs
-        else:
-            _timestamp = {"timestamp": timestamp}
-            merged_msg = {**_timestamp, **msg, **self.extra}
-            return self._dumps(merged_msg), kwargs
-
-    def _dumps(self, merged_msg):
-        try:
-            return json.dumps(merged_msg)
-        except Exception as e:
-            return self._dumps(str(e))
-
-
-class BenchmarksLogger(naz.log.SimpleLogger):
-    def bind(self, level: typing.Union[str, int], log_metadata: dict) -> None:
-        level = self._nameToLevel(level=level)
-        self._logger = logging.getLogger(self.logger_name)
+class BenchmarksLogger(logging.Logger):
+    def __init__(
+        self,
+        logger_name: str,
+        level: typing.Union[str, int] = logging.INFO,
+        log_metadata: typing.Union[None, dict] = None,
+        handler: typing.Union[None, logging.Handler] = None,
+    ) -> None:
+        super(BenchmarksLogger, self).__init__(logger_name, level, log_metadata, handler)
         formatter = logging.Formatter("%(message)s")
-
-        handler1 = logging.FileHandler(filename=log_file)
-        handler1.setFormatter(formatter)
-        handler1.setLevel(logging.DEBUG)
-        self._logger.addHandler(handler1)
-
-        # this may have been causing the issue mentioned at:
-        #  - https://github.com/komuw/naz/issues/103#issuecomment-500208481
-        # handler2 = logging.StreamHandler()
-        # handler2.setFormatter(formatter)
-        # handler2.setLevel(level)
-        # self._logger.addHandler(handler2)
-
-        self._logger.setLevel(level)
-        self.logger: logging.LoggerAdapter = MyLogAdapter(self._logger, log_metadata)
+        handler2 = logging.FileHandler(filename=log_file)
+        handler2.setFormatter(formatter)
+        handler2.setLevel(self.level)
+        self.addHandler(handler2)

benchmarks/smpp_n_broker_servers.py

@@ -34,9 +34,10 @@ def __init__(
         self.chaos = chaos
 
         self.docker_client = docker.from_env()
-        self.logger = naz.log.SimpleLogger("naz_benchmarks.{0}".format(self.container_name))
-        self.logger.bind(
-            level="INFO", log_metadata={"container_name": self.container_name, "chaos": self.chaos}
+        self.logger = naz.log.SimpleLogger(
+            "naz_benchmarks.{0}".format(self.container_name),
+            level="INFO",
+            log_metadata={"container_name": self.container_name, "chaos": self.chaos},
         )
 
         self.container_max_run_duration: float = 16.00  # mins

cli/utils/load.py

@@ -6,7 +6,7 @@
 import naz
 
 
-def load_class(dotted_path: str, logger: naz.log.BaseLogger) -> naz.Client:
+def load_class(dotted_path: str, logger: logging.Logger) -> naz.Client:
     """
     taken from: https://github.com/coleifer/huey/blob/4138d454cc6fd4d252c9350dbd88d74dd3c67dcb/huey/utils.py#L44
     huey is released under MIT license a copy of which can be found at: https://github.com/coleifer/huey/blob/master/LICENSE

cli/utils/sig.py

@@ -6,7 +6,7 @@
 import naz
 
 
-async def _signal_handling(logger: naz.log.BaseLogger, client: naz.Client) -> None:
+async def _signal_handling(logger: logging.Logger, client: naz.Client) -> None:
     try:
         loop = asyncio.get_running_loop()
     except RuntimeError:
@@ -34,7 +34,7 @@ async def _signal_handling(logger: naz.log.BaseLogger, client: naz.Client) -> No
 
 
 async def _handle_termination_signal(
-    logger: naz.log.BaseLogger, _signal: "signal.Signals", client: naz.Client
+    logger: logging.Logger, _signal: "signal.Signals", client: naz.Client
 ) -> None:
     logger.log(
         logging.INFO,