Merge pull request #528 from hneiva/log-rotation

Bug 1613283 - Add log rotation option for taskcluster.yaml

Author: hneiva

src/scriptworker/constants.py

@@ -56,7 +56,10 @@
         "task_max_timeout_status": STATUSES["intermittent-task"],
         "invalid_reclaim_status": STATUSES["intermittent-task"],
         "task_script": ("bash", "-c", "echo foo && sleep 19 && exit 1"),
+        # Logging settings
         "verbose": True,
+        "log_max_bytes": 0,
+        "log_max_backups": 10,
         # Task settings
         "work_dir": "...",
         "log_dir": "...",

src/scriptworker/log.py

@@ -57,6 +57,12 @@ def update_logging_config(context: Any, log_name: Optional[str] = None, file_nam
         # If we rotate the log file via logrotate.d, let's watch the file
         # so we can automatically close/reopen on move.
         handler = logging.handlers.WatchedFileHandler(path)  # type: ignore
+    elif context.config["log_max_bytes"] and context.config["log_max_backups"]:
+        handler = logging.handlers.RotatingFileHandler(  # type: ignore
+            filename=path,
+            maxBytes=context.config["log_max_bytes"],
+            backupCount=context.config["log_max_backups"],
+        )
     else:
         # Avoid using WatchedFileHandler during scriptworker unittests
         handler = logging.FileHandler(path)  # type: ignore

tests/test_log.py

@@ -115,3 +115,20 @@ def test_watched_log_file(rw_context):
     with open(path, "r") as fh:
         assert fh.read().rstrip() == "INFO - bar"
     close_handlers(log_name=rw_context.config["log_dir"])
+
+
+def test_rotating_log_file(rw_context):
+    # 500 should be enough to ~fill 2 files
+    MAX_SIZE = 500  # bytes
+    rw_context.config["watch_log_file"] = False
+    rw_context.config["log_max_bytes"] = MAX_SIZE
+    rw_context.config["log_max_backups"] = 1
+    rw_context.config["log_fmt"] = "%(levelname)s - %(message)s"
+    swlog.update_logging_config(rw_context, log_name=rw_context.config["log_dir"])
+    path = os.path.join(rw_context.config["log_dir"], "worker.log")
+    log = logging.getLogger(rw_context.config["log_dir"])
+    for x in range(30):
+        log.info(f"{x}" * x)
+    assert os.path.getsize(path) < MAX_SIZE
+    assert os.path.getsize(path + ".1") < MAX_SIZE
+    close_handlers(log_name=rw_context.config["log_dir"])