litewave-logger 0.1.0__py3-none-any.whl → 0.2.0__py3-none-any.whl

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/middleware.py

@@ -1,31 +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
 
-# This middleware is used to handle the request ID.
+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.
+    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):
-        request_id = request.headers.get("X-Request-ID")
+        # 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)
-        
-        response = await call_next(request)
-        response.headers["X-Request-ID"] = request_id_var.get()
-        return response
+
+        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.dist-info → litewave_logger-0.2.0.dist-info}/METADATA

@@ -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.2.0.dist-info/RECORD

@@ -0,0 +1,8 @@
+litewave_logger/__init__.py,sha256=kWrhjCNg8Zr15n0XE1ph6TXHQAUiyK0zZeFnRmieabU,2071
+litewave_logger/celery.py,sha256=KkeuXNTQm7P_TFj_POdt7WTHL-mcP_Jv60g06Fkw_M4,3358
+litewave_logger/middleware.py,sha256=3edT_iHYCDJXEm9w2DIOKYV664Xn4umLwXpZyDtqIts,2120
+litewave_logger/requests.py,sha256=tagJVwWWSVnrYHYRJ24HXu7YNBs9WxIHql0E1fRkbGA,1236
+litewave_logger-0.2.0.dist-info/METADATA,sha256=wPqhwIIgLaDLDVZe9WDh_QR3dSYlp76ReUqJHYLUVkg,3211
+litewave_logger-0.2.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+litewave_logger-0.2.0.dist-info/top_level.txt,sha256=omvs1vFc7ccmip7_gMDjF_3F8omnR-Gdfm2UudrqWuo,16
+litewave_logger-0.2.0.dist-info/RECORD,,

litewave_logger-0.1.0.dist-info/RECORD

@@ -1,8 +0,0 @@
-litewave_logger/__init__.py,sha256=NgRQIlAbGXrlVoL5hcWHs3jbeNZPJ3j9zLuPfpf6vPc,1443
-litewave_logger/celery.py,sha256=KkeuXNTQm7P_TFj_POdt7WTHL-mcP_Jv60g06Fkw_M4,3358
-litewave_logger/middleware.py,sha256=oiWsRO9i8W7hlQrg0wJvOmAxqTkjkvASKa2psaA9Tbk,1161
-litewave_logger/requests.py,sha256=tagJVwWWSVnrYHYRJ24HXu7YNBs9WxIHql0E1fRkbGA,1236
-litewave_logger-0.1.0.dist-info/METADATA,sha256=0TSMGW8hGWb42X7Ls7Hfe7LN7gIqv3eyPBDD0C7StwA,3211
-litewave_logger-0.1.0.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-litewave_logger-0.1.0.dist-info/top_level.txt,sha256=omvs1vFc7ccmip7_gMDjF_3F8omnR-Gdfm2UudrqWuo,16
-litewave_logger-0.1.0.dist-info/RECORD,,