fastapi-authly 0.1.26__tar.gz → 0.1.28__tar.gz

{fastapi_authly-0.1.26 → fastapi_authly-0.1.28}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: fastapi-authly
-Version: 0.1.26
+Version: 0.1.28
 Summary: A modular authentication system for FastAPI with OAuth2, JWT, and password recovery
 Project-URL: Homepage, https://github.com/yourusername/fastapi-auth-module
 Project-URL: Documentation, https://yourusername.github.io/fastapi-auth-module/

{fastapi_authly-0.1.26 → fastapi_authly-0.1.28}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "fastapi-authly"
-version = "0.1.26"
+version = "0.1.28"
 description = "A modular authentication system for FastAPI with OAuth2, JWT, and password recovery"
 readme = "README.md"
 license = {text = "MIT"}

{fastapi_authly-0.1.26 → fastapi_authly-0.1.28}/src/fastapi_authly/__about__.py

@@ -1,3 +1,3 @@
 """Version information."""
 
-__version__ = "0.1.26"
+__version__ = "0.1.28"

{fastapi_authly-0.1.26 → fastapi_authly-0.1.28}/src/fastapi_authly/core/config/base.py

@@ -1,5 +1,6 @@
 from pydantic import BaseModel, Field, field_validator
 from typing import Any, Optional, Literal
+from pathlib import Path
 
 class BaseBackendModel(BaseModel):
     @field_validator("*", mode="before")
@@ -30,6 +31,14 @@ class MinioConfig(BaseBackendModel):
     bucket_name: str = Field(..., description="MinIO 存储桶名称")
 
 
+class LoggingFileConfig(BaseModel):
+    enabled: bool = False
+    path: Path = Path("logs/app.jsonl")
+    max_bytes: int = Field(default=100 * 1024 * 1024, gt=0)
+    backup_count: int = Field(default=5, ge=0)
+
+
 class LoggingConfig(BaseModel):
     level: Literal["DEBUG","INFO","WARNING","ERROR","CRITICAL"] = "INFO"
-    format: Literal["console","rich","json"] = "console"
+    format: Literal["console", "rich"] = "console"
+    file: LoggingFileConfig = Field(default_factory=LoggingFileConfig)

{fastapi_authly-0.1.26 → fastapi_authly-0.1.28}/src/fastapi_authly/core/logging.py

@@ -1,11 +1,15 @@
 import inspect
+import json
 import logging
 import os
 import re
 import sys
 from contextvars import ContextVar
+from datetime import datetime, timezone
+from logging.handlers import RotatingFileHandler
+from pathlib import Path
 from time import perf_counter
-from typing import Literal
+from typing import Any, Literal
 from uuid import uuid4
 
 from fastapi import FastAPI, Request
@@ -20,8 +24,24 @@ _http_logger = logging.getLogger("http.request")
 
 
 class RequestContextFilter(logging.Filter):
+    def __init__(
+            self,
+            *,
+            service: str | None = None,
+            environment: str | None = None,
+            version: str | None = None,
+    ) -> None:
+        super().__init__()
+        self.service = service
+        self.environment = environment
+        self.version = version
+
     def filter(self, record: logging.LogRecord) -> bool:
         request_id = _REQUEST_ID.get()
+        record.request_id = request_id
+        record.service = getattr(record, "service", self.service)
+        record.environment = getattr(record, "environment", self.environment)
+        record.version = getattr(record, "version", self.version)
         record.request_context = (
             f"request_id={request_id} | " if request_id is not None else ""
         )
@@ -33,6 +53,48 @@ class RequestContextFilter(logging.Filter):
         return True
 
 
+class JsonLinesFormatter(logging.Formatter):
+    def format(self, record: logging.LogRecord) -> str:
+        payload: dict[str, Any] = {
+            "schema_version": "1.0",
+            "timestamp": datetime.fromtimestamp(
+                record.created,
+                tz=timezone.utc,
+            ).isoformat(),
+            "level": record.levelname,
+            "logger": record.name,
+            "message": record.getMessage(),
+            "module": record.module,
+            "function": record.funcName,
+            "line": record.lineno,
+        }
+
+        for field in (
+                "service",
+                "environment",
+                "version",
+                "request_id",
+                "endpoint",
+                "method",
+                "path",
+                "status_code",
+                "duration_ms",
+        ):
+            value = getattr(record, field, None)
+            if value is not None:
+                payload[field] = value
+
+        if record.exc_info:
+            exception_type, exception, _ = record.exc_info
+            payload["exception"] = {
+                "type": exception_type.__name__,
+                "message": str(exception),
+                "stacktrace": self.formatException(record.exc_info),
+            }
+
+        return json.dumps(payload, ensure_ascii=False, default=str)
+
+
 def _normalize_level(level: int | str | None) -> int:
     value = level or os.getenv("LOG_LEVEL", "INFO")
     if isinstance(value, int):
@@ -76,10 +138,25 @@ def _get_endpoint_name(request: Request) -> str:
 def setup_logging(
         level: int | str | None = None,
         format: LogFormat | str | None = None,
+        *,
+        service: str | None = None,
+        environment: str | None = None,
+        version: str | None = None,
+        file_path: str | Path | None = None,
+        file_max_bytes: int = 100 * 1024 * 1024,
+        file_backup_count: int = 5,
 ) -> None:
     resolved_level = _normalize_level(level)
     resolved_format = _normalize_format(format)
-    context_filter = RequestContextFilter()
+    if file_max_bytes <= 0:
+        raise ValueError("file_max_bytes 必须大于 0")
+    if file_backup_count < 0:
+        raise ValueError("file_backup_count 不能小于 0")
+    context_filter = RequestContextFilter(
+        service=service,
+        environment=environment,
+        version=version,
+    )
 
     if resolved_format == "rich":
         handler = RichHandler(
@@ -110,10 +187,28 @@ def setup_logging(
         )
 
     handler.addFilter(context_filter)
+    handlers: list[logging.Handler] = [handler]
+
+    resolved_file_path = file_path or os.getenv("LOG_FILE_PATH")
+    if resolved_file_path:
+        log_path = Path(resolved_file_path)
+        log_path.parent.mkdir(parents=True, exist_ok=True)
+        file_handler = RotatingFileHandler(
+            log_path,
+            maxBytes=file_max_bytes,
+            backupCount=file_backup_count,
+            encoding="utf-8",
+        )
+        file_handler.setLevel(resolved_level)
+        file_handler.setFormatter(JsonLinesFormatter())
+        file_handler.addFilter(context_filter)
+        handlers.append(file_handler)
+
     root_logger = logging.getLogger()
     root_logger.handlers.clear()
     root_logger.setLevel(resolved_level)
-    root_logger.addHandler(handler)
+    for configured_handler in handlers:
+        root_logger.addHandler(configured_handler)
 
     for logger_name in ("uvicorn", "uvicorn.error"):
         framework_logger = logging.getLogger(logger_name)
@@ -160,7 +255,12 @@ def setup_request_logging(app: FastAPI) -> None:
                 request.method,
                 path,
                 duration_ms,
-                extra={"endpoint": _get_endpoint_name(request)},
+                extra={
+                    "endpoint": _get_endpoint_name(request),
+                    "method": request.method,
+                    "path": path,
+                    "duration_ms": round(duration_ms, 2),
+                },
             )
             raise
         else:
@@ -179,7 +279,13 @@ def setup_request_logging(app: FastAPI) -> None:
                 path,
                 status_code,
                 duration_ms,
-                extra={"endpoint": _get_endpoint_name(request)},
+                extra={
+                    "endpoint": _get_endpoint_name(request),
+                    "method": request.method,
+                    "path": path,
+                    "status_code": status_code,
+                    "duration_ms": round(duration_ms, 2),
+                },
             )
             response.headers["X-Request-ID"] = request_id
             return response