feat(cli): add new command line switch --log-config to specify a python json log configuration

Author: d-biehl

packages/core/src/robotcode/core/utils/logging.py

@@ -203,10 +203,9 @@ def log(
             if context_name is not None:
                 depth = self._measure_contexts.get(context_name, 0)
 
-            if depth > 0:
-                extra = {**extra} if extra is not None else {}
-                if "indent" not in extra:
-                    extra["indent"] = "  " * depth
+            extra = {**extra} if extra is not None else {}
+            if "indent" not in extra:
+                extra["indent"] = ("  " * depth) if depth > 0 else ""
 
             self.logger.log(
                 level,

packages/debugger/src/robotcode/debugger/server.py

@@ -196,15 +196,15 @@ async def _terminate(
         Debugger.instance().terminate()
 
         if not restart and not self._sigint_signaled:
-            self._logger.info("Send SIGINT to process")
+            self._logger.debug("Send SIGINT to process")
             signal.raise_signal(signal.SIGINT)
             self._sigint_signaled = True
 
             Debugger.instance().continue_all_if_paused()
         else:
             await self.send_event_async(Event("terminateRequested"))
 
-            self._logger.info("Send SIGTERM to process")
+            self._logger.debug("Send SIGTERM to process")
             signal.raise_signal(signal.SIGTERM)
 
     @rpc_method(name="disconnect", param_type=DisconnectArguments)

src/robotcode/cli/__init__.py

@@ -1,4 +1,6 @@
+import json
 import logging
+import logging.config
 from pathlib import Path
 from typing import Any, List, Literal, Optional
 
@@ -35,8 +37,11 @@ def my_make_metavar(self: click.Parameter, *args: Any, **kwargs: Any) -> str:
 
 
 class RobotCodeFormatter(logging.Formatter):
-    def __init__(self, *args: Any, **kwargs: Any) -> None:
-        super().__init__(*args, **kwargs)
+    def __init__(self, *args: Any, defaults: Any = None, **kwargs: Any) -> None:
+        defaults = defaults or {}
+        if defaults.get("indent") is None:
+            defaults["indent"] = ""
+        super().__init__(*args, defaults=defaults, **kwargs)
 
 
 @click.group(
@@ -162,6 +167,21 @@ def __init__(self, *args: Any, **kwargs: Any) -> None:
     help="Enables logging of method/function calls.",
     show_envvar=True,
 )
+@click.option(
+    "--log-config",
+    type=click.Path(
+        file_okay=True,
+        dir_okay=False,
+        readable=True,
+        exists=True,
+        path_type=str,
+    ),
+    help="Path to a logging configuration file. This must be a valid Python logging configuration file in JSON format."
+    " If this option is set, the other logging options are ignored.",
+    default=None,
+    show_default=True,
+    show_envvar=True,
+)
 @click.option(
     "--default-path",
     "-dp",
@@ -220,6 +240,7 @@ def robotcode(
     log_style: Literal["%", "{", "$"],
     log_filename: Optional[str],
     log_calls: bool,
+    log_config: Optional[Path],
     default_path: Optional[List[str]],
     launcher_script: Optional[str] = None,
     debugpy: bool = False,
@@ -257,7 +278,21 @@ def robotcode(
     app.config.log_level = log_level
     app.config.log_calls = log_calls
 
-    if log:
+    if log_config:
+        if log_calls:
+            LoggingDescriptor.set_call_tracing(True)
+
+        app.verbose(f"Loading logging configuration from '{log_config}'")
+        try:
+            with open(log_config, "r", encoding="utf-8") as f:
+                config = json.load(f)
+
+            logging.config.dictConfig(config)
+
+        except Exception as e:
+            app.error(f"Failed to load logging configuration from '{log_config}': {e}")
+
+    elif log:
         if log_calls:
             LoggingDescriptor.set_call_tracing(True)
 
@@ -269,9 +304,7 @@ def robotcode(
         )
 
         try:
-            logging.root.handlers[0].formatter = RobotCodeFormatter(
-                fmt=log_format, style=log_style, defaults={"indent": ""}
-            )
+            logging.root.handlers[0].formatter = RobotCodeFormatter(fmt=log_format, style=log_style)
         except TypeError:
             pass
 

tests/robotcode/language_server/robotframework/parts/data/.vscode/settings.json

@@ -19,6 +19,8 @@
         "--log",
         "--log-level", "DEBUG",
         // "--log-format", "%(indent)s%(levelname)s:%(name)s:%(filename)s:%(lineno)d: %(message)s"
+
+        // "--log-config", "logging.json"
     ],
     // "robotcode.robocop.configFile": "pyproject.toml",
     "robotcode.robocop.enabled": true,

tests/robotcode/language_server/robotframework/parts/data/logging.json

@@ -0,0 +1,35 @@
+{
+    "version": 1,
+    "disable_existing_loggers": true,
+    "formatters": {
+        "standard": {
+            "class": "robotcode.cli.RobotCodeFormatter",
+            "format": "%(indent)s %(asctime)s %(name)s %(levelname)s: %(message)s"
+        }
+    },
+    "handlers": {
+        "console": {
+            "level": "DEBUG",
+            "class": "logging.StreamHandler",
+            "formatter": "standard"
+        },
+        "file_handler": {
+            "level": "DEBUG",
+            "class": "logging.handlers.RotatingFileHandler",
+            "formatter": "standard",
+            "filename": "info.log",
+            "mode": "w",
+            "maxBytes": 26214400,
+            "backupCount": 10,
+            "encoding": "utf8"
+        }
+    },
+
+    "root": {
+        "level": "DEBUG",
+        "handlers": [
+            "console",
+            "file_handler"
+        ]
+    }
+}