device-server: add --logging-dir option (#267)

Author: iandobbie

microscope/device_server.py

@@ -40,6 +40,7 @@
 import importlib.util
 import logging
 import multiprocessing
+import os.path
 import signal
 import sys
 import time
@@ -197,6 +198,7 @@ class DeviceServerOptions:
 
     config_fpath: str
     logging_level: int
+    logging_dir: str
 
 
 def _check_autoproxy_feature() -> None:
@@ -308,6 +310,7 @@ def run(self):
         # based on a unique identifier for the device. Some devices
         # don't have UIDs available until after initialization, so
         # log to stderr until then.
+
         stderr_handler = StreamHandler(sys.stderr)
         stderr_handler.setFormatter(_create_log_formatter(cls_name))
         root_logger.addHandler(stderr_handler)
@@ -351,7 +354,10 @@ def run(self):
         pyro_daemon = Pyro4.Daemon(port=port, host=host)
 
         log_handler = RotatingFileHandler(
-            "%s_%s_%s.log" % (cls_name, host, port)
+            os.path.join(
+                self._options.logging_dir,
+                "%s_%s_%s.log" % (cls_name, host, port),
+            )
         )
         log_handler.setFormatter(_create_log_formatter(cls_name))
         root_logger.addHandler(log_handler)
@@ -560,6 +566,14 @@ def _parse_cmd_line_args(args: typing.Sequence[str]) -> DeviceServerOptions:
         choices=["debug", "info", "warning", "error", "critical"],
         help="Set logging level",
     )
+    parser.add_argument(
+        "--logging-dir",
+        action="store",
+        type=str,
+        default="",
+        help="Directory where log files are written to",
+    )
+
     parser.add_argument(
         "config_fpath",
         action="store",
@@ -571,6 +585,7 @@ def _parse_cmd_line_args(args: typing.Sequence[str]) -> DeviceServerOptions:
     return DeviceServerOptions(
         config_fpath=parsed.config_fpath,
         logging_level=getattr(logging, parsed.logging_level.upper()),
+        logging_dir=parsed.logging_dir,
     )
 
 

microscope/testsuite/test_device_server.py

@@ -112,6 +112,7 @@ def setUp(self):
         options = microscope.device_server.DeviceServerOptions(
             config_fpath="",
             logging_level=logging.INFO,
+            logging_dir="",
         )
         self.p = multiprocessing.Process(
             target=microscope.device_server.serve_devices,
@@ -274,6 +275,7 @@ class TestServingFloatingDevicesWithWrongUID(BaseTestDeviceServer):
         microscope.device_server.DeviceServerOptions(
             config_fpath="",
             logging_level=logging.INFO,
+            logging_dir="",
         ),
         {"bar": "127.0.0.1"},
         {"bar": 8001},
@@ -307,6 +309,7 @@ class TestFunctionInDeviceDefinition(BaseTestDeviceServer):
         microscope.device_server.DeviceServerOptions(
             config_fpath="",
             logging_level=logging.INFO,
+            logging_dir="",
         ),
         {},
         {},