litewave-logger 0.1.0__tar.gz → 0.2.0__tar.gz

{litewave_logger-0.1.0 → litewave_logger-0.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: litewave_logger
-Version: 0.1.0
+Version: 0.2.0
 Summary: A lightweight logging library with context carry forward
 Author: Litewave
 Author-email: Sonu Sudhakaran <sonu@litewave.ai>

{litewave_logger-0.1.0 → litewave_logger-0.2.0}/litewave_logger/__init__.py

@@ -1,5 +1,5 @@
 import logging
-import uuid
+import json
 from contextvars import ContextVar
 
 # Context variable to hold the request ID
@@ -17,11 +17,28 @@ class RequestIdFilter(logging.Filter):
         record.request_id = request_id_var.get()
         return True
 
+class JsonLogFormatter(logging.Formatter):
+    """
+    Formatter that outputs logs as JSON with required fields.
+    """
+    def format(self, record):
+        # Collect fields with fallback to None for path, method, and status_code
+        log_object = {
+            "timestamp": self.formatTime(record, self.datefmt),
+            "level": record.levelname,
+            "request_id": getattr(record, "request_id", None),
+            "path": getattr(record, "path", None),
+            "method": getattr(record, "method", None),
+            "message": record.getMessage(),
+            "status_code": getattr(record, "status_code", None),
+            "error": getattr(record, "error", None),
+        }
+        return json.dumps(log_object)
 
 def setup_logging():
     """
     Configures the logging for the application.
-    It sets up a handler, a formatter, and adds the RequestIdFilter.
+    Uses a JSON formatter and adds the RequestIdFilter.
     """
     logger = logging.getLogger()
     logger.setLevel(logging.INFO)
@@ -29,9 +46,7 @@ def setup_logging():
     # Prevent adding duplicate handlers
     if not logger.handlers:
         handler = logging.StreamHandler()
-        formatter = logging.Formatter(
-            "%(asctime)s - %(name)s - %(levelname)s - [%(request_id)s] - %(message)s"
-        )
+        formatter = JsonLogFormatter()
         handler.setFormatter(formatter)
         logger.addHandler(handler)
 

litewave_logger-0.2.0/litewave_logger/middleware.py

@@ -0,0 +1,59 @@
+import uuid
+import time
+import logging
+from datetime import datetime
+from starlette.middleware.base import BaseHTTPMiddleware
+from starlette.requests import Request
+
+from . import request_id_var
+
+logger = logging.getLogger(__name__)
+RequestIdHeader = "X-Request-ID"
+# This middleware is used to handle the request ID and provide comprehensive debugging.
+# It checks for a 'X-Request-ID' header in the incoming request.
+# If the header is present, its value is used as the request ID.
+# If not, a new UUID is generated.
+# The request ID is then stored in a context variable.
+class RequestIdMiddleware(BaseHTTPMiddleware):
+    """
+    FastAPI middleware to handle the request ID and provide comprehensive debugging.
+    It checks for a 'X-Request-ID' header in the incoming request.
+    If the header is present, its value is used as the request ID.
+    If not, a new UUID is generated.
+    The request ID is then stored in a context variable.
+    Provides detailed logging for incoming requests and outgoing responses.
+    """
+    async def dispatch(self, request: Request, call_next):
+        # Extract request information
+        method = request.method
+        path = request.url.path
+        # Get or generate request ID
+        request_id = request.headers.get(RequestIdHeader)
+        if not request_id:
+            request_id = str(uuid.uuid4())
+
+        # Set request ID in context
+        request_id_var.set(request_id)
+
+        logger.info("request received", extra={"method": method, "path": path})
+
+        try:
+            # Process the request
+            response = await call_next(request)
+
+            # Add request ID to response headers
+            response.headers[RequestIdHeader] = request_id
+
+            # Log response details
+            logger.info("response sent", extra={"status_code": response.status_code})
+
+            return response
+
+        except Exception as e:
+            # Log error details
+            logger.error("request failed", extra={"method": method, "path": path, "error": str(e)})
+
+            # Re-raise the exception
+            raise
+
+__all__ = ["RequestIdMiddleware"]

{litewave_logger-0.1.0 → litewave_logger-0.2.0}/litewave_logger.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: litewave_logger
-Version: 0.1.0
+Version: 0.2.0
 Summary: A lightweight logging library with context carry forward
 Author: Litewave
 Author-email: Sonu Sudhakaran <sonu@litewave.ai>

{litewave_logger-0.1.0 → litewave_logger-0.2.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "litewave_logger"
-version = "0.1.0"
+version = "0.2.0"
 description = "A lightweight logging library with context carry forward"
 authors = [{name = "Sonu Sudhakaran", email = "sonu@litewave.ai"}]
 dependencies = [

{litewave_logger-0.1.0 → litewave_logger-0.2.0}/setup.py

@@ -2,7 +2,7 @@ from setuptools import setup, find_packages
 
 setup(
     name="litewave_logger",
-    version="0.1.0",
+    version="0.2.0",
     description="A centralized logging module for Litewave services.",
     author="Litewave",
     packages=find_packages(),

litewave_logger-0.1.0/litewave_logger/middleware.py

@@ -1,31 +0,0 @@
-import uuid
-from starlette.middleware.base import BaseHTTPMiddleware
-from starlette.requests import Request
-
-from . import request_id_var
-
-# This middleware is used to handle the request ID.
-# It checks for a 'X-Request-ID' header in the incoming request.
-# If the header is present, its value is used as the request ID.
-# If not, a new UUID is generated.
-# The request ID is then stored in a context variable.
-class RequestIdMiddleware(BaseHTTPMiddleware):
-    """
-    FastAPI middleware to handle the request ID.
-    It checks for a 'X-Request-ID' header in the incoming request.
-    If the header is present, its value is used as the request ID.
-    If not, a new UUID is generated.
-    The request ID is then stored in a context variable.
-    """
-    async def dispatch(self, request: Request, call_next):
-        request_id = request.headers.get("X-Request-ID")
-        if not request_id:
-            request_id = str(uuid.uuid4())
-        
-        request_id_var.set(request_id)
-        
-        response = await call_next(request)
-        response.headers["X-Request-ID"] = request_id_var.get()
-        return response
-
-__all__ = ["RequestIdMiddleware"]