Allow user to specify the basename of the log file (#60)

Author: AndrewNepogoda

cli/README.md

@@ -99,6 +99,7 @@ data_path="./data"
 | Logging level for cli                                                                                                                                                                   | `--log-level`                            | `False`     | `INFO`                  | `String`                | `['DEBUG', 'INFO', 'WARNING', 'ERROR', 'CRITICAL']`                                                                                   |
 | Log rotation option. If `date` options is enabled RWM rotates logs each day. If `size` option is enabled RWM rotates log file when it reaches this size                                 | `--log-rotation`                         | `False`     | `date`                  | `String`                | `['date', 'size']`                                                                                                                    |
 | Rotation log file size in Mb. RWM rotates log file when it reaches this size and `--log-rotation` is `size`                                                                             | `--log-file-size`                        | `False`     | `5`                     | `Int`                   |                                                                                                                                       |
+| Log file name                                                                                                                                                                           | `--log-file-name`                        | `False`     | `rwm`                   | `String`                |                                                                                                                                       |
 | Drop database before workflow run, or not                                                                                                                                               | `--drop-db`                              | `False`     | `False`                 | `BooleanOptionalAction` | `True` - `--drop-db`, `False` - `--no-drop-db`, no argument - default value                                                           |
 | Remove RAI engine and database after run or not                                                                                                                                         | `--cleanup-resources`                    | `False`     | `False`                 | `BooleanOptionalAction` | `True` - `--cleanup-resources`, `False` - `--no-cleanup-resources`, no argument - default value                                       |
 | Remove RAI engine after run or not                                                                                                                                                      | `--cleanup-engine`                       | `False`     | `False`                 | `BooleanOptionalAction` | `True` - `--cleanup-engine`, `False` - `--no-cleanup-engine`, no argument - default value                                             |

cli/args.py

@@ -1,6 +1,9 @@
+import re
 from argparse import ArgumentParser, Namespace, BooleanOptionalAction
 from cli.logger import LogRotationOption
 
+prohibited_symbols_in_file_name = re.compile(r'[\\/:*?"<>|]')
+
 
 def parse() -> Namespace:
     parser = ArgumentParser()
@@ -100,6 +103,13 @@ def parse() -> Namespace:
         type=int,
         default=5  # 5 Mb
     )
+    parser.add_argument(
+        "--log-file-name",
+        help="Log file name",
+        required=False,
+        type=str,
+        default="rwm"
+    )
     parser.add_argument(
         "--drop-db",
         help="Drop RAI database before run, or not",
@@ -181,6 +191,9 @@ def parse() -> Namespace:
         except ValueError:
             parser.error("`--step-timeout` should be key value pairs separated by comma. Value must have `int` type. "
                          "Example: `--step-timeout \"step1=10,step2=20`\"")
+    if 'log_file_name' in vars(args):
+        if prohibited_symbols_in_file_name.search(args.log_file_name):
+            parser.error(f"`--log-file-name` contains prohibited symbols: {prohibited_symbols_in_file_name.pattern}")
     return args
 
 

cli/logger.py

@@ -1,41 +1,49 @@
 import logging
+import dataclasses
 from logging.handlers import TimedRotatingFileHandler, RotatingFileHandler
 from workflow.common import BaseEnum
 
-log_filename = 'rwm.log'
-
 
 class LogRotationOption(str, BaseEnum):
     DATE = 'date'
     SIZE = 'size'
 
 
-def configure(level=logging.INFO, rotation: LogRotationOption = LogRotationOption.DATE,
-              log_file_size: int = 5) -> logging.Logger:
+@dataclasses.dataclass
+class LogConfiguration:
+    level: int = logging.INFO
+    rotation: LogRotationOption = LogRotationOption.DATE
+    log_file_size: int = 5
+    log_file_name: str = "rwm"
+
+
+def configure(config: LogConfiguration) -> logging.Logger:
     # override default logging level for azure
     logger = logging.getLogger('azure.core')
     logger.setLevel(logging.ERROR)
     logger = logging.getLogger('snowflake')
     logger.setLevel(logging.ERROR)
 
     logger = logging.getLogger()
-    logger.setLevel(level)
+    logger.setLevel(config.level)
     formatter = logging.Formatter('[%(asctime)s.%(msecs)03d][%(levelname)s][%(name)s] %(message)s', '%Y-%m-%d %H:%M:%S')
 
     stream_handler = logging.StreamHandler()
     stream_handler.setFormatter(formatter)
     logger.addHandler(stream_handler)
 
-    if rotation == LogRotationOption.SIZE:
-        max_log_size = log_file_size * 1024 * 1024  # covert to Mb
-        size_rotation_handler = RotatingFileHandler(log_filename, maxBytes=max_log_size, backupCount=30,
+    full_log_file_name = f"{config.log_file_name}.log"
+
+    if config.rotation == LogRotationOption.SIZE:
+        max_log_size = config.log_file_size * 1024 * 1024  # covert to Mb
+        size_rotation_handler = RotatingFileHandler(full_log_file_name, maxBytes=max_log_size, backupCount=30,
                                                     encoding='utf-8')
         size_rotation_handler.setFormatter(formatter)
         logger.addHandler(size_rotation_handler)
         logger.info("Log rotation by size is enabled")
-    elif rotation == LogRotationOption.DATE:
-        time_rotation_handler = TimedRotatingFileHandler(log_filename, when='midnight', interval=1, backupCount=30,
-                                                         encoding='utf-8')
+    elif config.rotation == LogRotationOption.DATE:
+        time_rotation_handler = TimedRotatingFileHandler(full_log_file_name, when='midnight', interval=1,
+                                                         backupCount=30, encoding='utf-8')
         time_rotation_handler.setFormatter(formatter)
         logger.addHandler(time_rotation_handler)
         logger.info("Log rotation by date is enabled")

cli/runner.py

@@ -16,7 +16,9 @@ def start():
     # parse arguments
     args = cli.args.parse()
     # configure logger
-    logger = cli.logger.configure(logging.getLevelName(args.log_level), args.log_rotation, args.log_file_size)
+    log_config = cli.logger.LogConfiguration(logging.getLevelName(args.log_level), args.log_rotation,
+                                             args.log_file_size, args.log_file_name)
+    logger = cli.logger.configure(log_config)
     try:
         with open(args.env_config, "rb") as fp:
             loader_config = tomli.load(fp)

workflow/__init__.py

@@ -12,5 +12,5 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-__version_info__ = (0, 0, 31)
+__version_info__ = (0, 0, 32)
 __version__ = ".".join(map(str, __version_info__))