Add --debug flag and structured logging

Add --debug flag to superset-cluster shell script that sets
SUPERSET_CLUSTER_DEBUG=1. Add configure_logging() that sets DEBUG level
when the env var is set. Replace print() with logger calls in
initialize.py. Enhance log_remote_command_execution decorator to emit
raw stdout/stderr at DEBUG level while keeping INFO concise.

Closes #67
Closes #53

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Author: 2 people

CHANGELOG.md

@@ -21,6 +21,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 * SQL Lab query row limits, timeout caps, and validation timeout. (#81)
 * Superset metastore and explore form data caching via Redis. (#79)
 
+### Added
+
+* `--debug` flag and structured logging with `configure_logging()`. (#67)
+
 ### Changed
 
 * Completed [ARCHITECTURE.md](./docs/ARCHITECTURE.md) (#93)

src/initialize.py

@@ -59,6 +59,8 @@
 import functools
 import ipaddress
 import itertools
+import logging
+import os
 import re
 import socket
 
@@ -67,6 +69,19 @@
 import remote
 
 
+def configure_logging() -> None:
+    level = logging.DEBUG if os.environ.get('SUPERSET_CLUSTER_DEBUG') else logging.INFO
+    logging.basicConfig(
+        level=level,
+        format='%(asctime)s [%(levelname)s] [%(name)s] %(message)s'
+    )
+    logging.getLogger('paramiko').setLevel(logging.WARNING)
+    logging.getLogger('urllib3').setLevel(logging.WARNING)
+
+
+logger = logging.getLogger(__name__)
+
+
 @decorators.Overlay.run_all_methods  # type: ignore[arg-type]
 class ArgumentParser:
     def validate_virtual_ip_address(self) -> None:
@@ -299,6 +314,7 @@ def start_cluster(self) -> None:
 
 if __name__ == "__main__":
     if len(sys.argv) != 6:
-        print("Invalid form of arguments provided")
+        logger.error("Invalid form of arguments provided")
         sys.exit(1)
+    configure_logging()
     Controller().start_cluster()

src/remote.py

@@ -94,7 +94,12 @@ def wrapper(*args, **kwargs):
             result = func(*args, **kwargs)
             if result["output"]:
                 logger.info(
-                    "[Node: %s] Command: %s - Output:\n%s",
+                    "[Node: %s] Command: %s completed",
+                    getattr(self, 'node', 'UnknownNode'),
+                    command
+                )
+                logger.debug(
+                    "[Node: %s] Command: %s - stdout:\n%s",
                     getattr(self, 'node', 'UnknownNode'),
                     command,
                     result["output"]
@@ -106,6 +111,12 @@ def wrapper(*args, **kwargs):
                     command,
                     result["error"]
                 )
+                logger.debug(
+                    "[Node: %s] Command: %s - stderr:\n%s",
+                    getattr(self, "node", "UnknownNode"),
+                    command,
+                    result["error"]
+                )
             return result
         return wrapper
 

superset-cluster

@@ -20,6 +20,8 @@ display_help() {
     echo "  --virtual-network-mask <mask>           Network mask for the virtual network gateway."
     echo "                                          Example: --virtual-network-mask 24"
     echo
+    echo "  --debug                               Enable debug-level logging."
+    echo
     echo "  -h, --help                              Show this help message and exit."
     echo
     echo "Example:"
@@ -59,6 +61,9 @@ parse_arguments() {
                 display_help
                 exit 0
                 ;;
+            --debug)
+                export SUPERSET_CLUSTER_DEBUG=1
+                ;;
             *)
                 echo "Unknown option: $1"
                 display_help