|
| 1 | +import os |
| 2 | +import sys |
| 3 | +import json |
| 4 | +import logging |
| 5 | +import logging.handlers |
| 6 | +from pathlib import Path |
| 7 | +from typing import Any, Dict |
| 8 | + |
| 9 | +# Get the base directory for logs |
| 10 | +LOGS_DIR = Path(os.getenv("RAVENCHAIN_LOGS_DIR", "logs")) |
| 11 | +LOGS_DIR.mkdir(parents=True, exist_ok=True) |
| 12 | + |
| 13 | +# Log file paths |
| 14 | +MAIN_LOG = LOGS_DIR / "ravenchain.log" |
| 15 | +ERROR_LOG = LOGS_DIR / "error.log" |
| 16 | +DEBUG_LOG = LOGS_DIR / "debug.log" |
| 17 | + |
| 18 | + |
| 19 | +class JSONFormatter(logging.Formatter): |
| 20 | + """ |
| 21 | + Formatter that outputs JSON strings after gathering all the log record args |
| 22 | + """ |
| 23 | + |
| 24 | + def __init__(self, **kwargs: Any) -> None: |
| 25 | + self.default_fields = kwargs |
| 26 | + super().__init__() |
| 27 | + |
| 28 | + def format(self, record: logging.LogRecord) -> str: |
| 29 | + message = { |
| 30 | + "timestamp": self.formatTime(record), |
| 31 | + "level": record.levelname, |
| 32 | + "message": record.getMessage(), |
| 33 | + "module": record.module, |
| 34 | + "function": record.funcName, |
| 35 | + "line": record.lineno, |
| 36 | + } |
| 37 | + |
| 38 | + # Add extra fields from record |
| 39 | + if hasattr(record, "props"): |
| 40 | + message.update(record.props) |
| 41 | + |
| 42 | + # Add default fields |
| 43 | + if self.default_fields: |
| 44 | + message.update(self.default_fields) |
| 45 | + |
| 46 | + if record.exc_info: |
| 47 | + message["exc_info"] = self.formatException(record.exc_info) |
| 48 | + |
| 49 | + return json.dumps(message) |
| 50 | + |
| 51 | + |
| 52 | +class StructuredLogger(logging.Logger): |
| 53 | + """ |
| 54 | + Custom logger class that allows structured logging with additional properties |
| 55 | + """ |
| 56 | + |
| 57 | + def _log( |
| 58 | + self, |
| 59 | + level: int, |
| 60 | + msg: str, |
| 61 | + args: tuple, |
| 62 | + exc_info: Any = None, |
| 63 | + extra: Dict = None, |
| 64 | + stack_info: bool = False, |
| 65 | + **kwargs: Any, |
| 66 | + ) -> None: |
| 67 | + if extra is None: |
| 68 | + extra = {} |
| 69 | + if kwargs: |
| 70 | + extra["props"] = kwargs |
| 71 | + super()._log(level, msg, args, exc_info, extra, stack_info) |
| 72 | + |
| 73 | + |
| 74 | +def setup_logging( |
| 75 | + service_name: str = "ravenchain", |
| 76 | + log_level: str = None, |
| 77 | + json_output: bool = False, |
| 78 | + console_output: bool = True, |
| 79 | +) -> logging.Logger: |
| 80 | + """ |
| 81 | + Set up logging configuration |
| 82 | +
|
| 83 | + Args: |
| 84 | + service_name: Name of the service (default: 'ravenchain') |
| 85 | + log_level: Override default log level from environment |
| 86 | + json_output: Whether to output logs in JSON format |
| 87 | + console_output: Whether to output logs to console |
| 88 | + """ |
| 89 | + # Register our custom logger class |
| 90 | + logging.setLoggerClass(StructuredLogger) |
| 91 | + |
| 92 | + # Determine log level from environment or parameter |
| 93 | + log_level = log_level or os.getenv("LOG_LEVEL", "INFO") |
| 94 | + numeric_level = getattr(logging, log_level.upper(), logging.INFO) |
| 95 | + |
| 96 | + # Create logger |
| 97 | + logger = logging.getLogger(service_name) |
| 98 | + logger.setLevel(numeric_level) |
| 99 | + logger.handlers = [] # Reset handlers if they exist |
| 100 | + |
| 101 | + # Formatter |
| 102 | + if json_output: |
| 103 | + formatter = JSONFormatter(service=service_name) |
| 104 | + else: |
| 105 | + formatter = logging.Formatter( |
| 106 | + "%(asctime)s - %(name)s - %(levelname)s - %(module)s:%(funcName)s:%(lineno)d - %(message)s" |
| 107 | + ) |
| 108 | + |
| 109 | + # Console handler |
| 110 | + if console_output: |
| 111 | + console_handler = logging.StreamHandler(sys.stdout) |
| 112 | + console_handler.setFormatter(formatter) |
| 113 | + logger.addHandler(console_handler) |
| 114 | + |
| 115 | + # Main rotating file handler |
| 116 | + main_handler = logging.handlers.RotatingFileHandler( |
| 117 | + MAIN_LOG, maxBytes=10 * 1024 * 1024, backupCount=5 # 10MB |
| 118 | + ) |
| 119 | + main_handler.setFormatter(formatter) |
| 120 | + logger.addHandler(main_handler) |
| 121 | + |
| 122 | + # Error file handler |
| 123 | + error_handler = logging.handlers.RotatingFileHandler( |
| 124 | + ERROR_LOG, maxBytes=10 * 1024 * 1024, backupCount=5 # 10MB |
| 125 | + ) |
| 126 | + error_handler.setLevel(logging.ERROR) |
| 127 | + error_handler.setFormatter(formatter) |
| 128 | + logger.addHandler(error_handler) |
| 129 | + |
| 130 | + # Debug file handler (only active if debug level is set) |
| 131 | + if numeric_level <= logging.DEBUG: |
| 132 | + debug_handler = logging.handlers.RotatingFileHandler( |
| 133 | + DEBUG_LOG, maxBytes=10 * 1024 * 1024, backupCount=5 # 10MB |
| 134 | + ) |
| 135 | + debug_handler.setLevel(logging.DEBUG) |
| 136 | + debug_handler.setFormatter(formatter) |
| 137 | + logger.addHandler(debug_handler) |
| 138 | + |
| 139 | + return logger |
| 140 | + |
| 141 | + |
| 142 | +# Example usage: |
| 143 | +# logger = setup_logging('ravenchain.cli', json_output=True) |
| 144 | +# logger.info("Starting application", version="1.0.0", env="production") |
| 145 | +# logger.error("Database connection failed", db_host="localhost", retry_count=3) |
0 commit comments