Merge pull request #8 from redb0/logger-filter

Logger filter

Author: redb0

docs_src/example_8.py

@@ -59,6 +59,7 @@ class LogWithUser(LogModel, table=True):
         'login_type': ['session', 'login_type'],
         'name': ['session', 'name'],
     },
+    available_loggers=['api.access'],
 )
 
 logger = structlog.get_logger()

fastapi_structlog/__init__.py

@@ -7,7 +7,7 @@
 
 import logging
 import logging.handlers
-from collections.abc import Callable
+from collections.abc import Callable, Sequence
 from typing import Any, Optional, Union
 
 from sqlalchemy.engine.url import URL
@@ -32,6 +32,7 @@ def setup_logger(  # noqa: PLR0913
     key_aliases: Optional[dict[str, list[str]]] = None,
     key_handlers: Optional[dict[str, Callable[[Any, logging.LogRecord], Any]]] = None,
     search_paths: Optional[dict[str, list[str]]] = None,
+    available_loggers: Optional[Sequence[str]] = None,
 ) -> Optional[logging.handlers.QueueListener]:
     """Initialize the logger with the configuration.
 
@@ -50,6 +51,8 @@ def setup_logger(  # noqa: PLR0913
         search_paths (Optional[dict[str, list[str]]], optional): Search paths
             for model attributes. This can be useful when searching for
             attributes in nested log structures.
+        available_loggers (Optional[Sequence[str]], optional): Names of the
+            loggers that will be included in the database.
     """
     configurator = LoggerConfigurator(settings_)
     configurator.add_base_handler()
@@ -79,6 +82,7 @@ def setup_logger(  # noqa: PLR0913
                 key_aliases=key_aliases,
                 search_paths=search_paths,
                 key_handlers=key_handlers,
+                available_loggers=available_loggers
             ),
         )
 

fastapi_structlog/db_handler/handler.py

@@ -5,7 +5,7 @@
 import logging
 import logging.handlers
 from abc import abstractmethod
-from collections.abc import Callable
+from collections.abc import Callable, Sequence
 from typing import Any, Generic, Optional, TypeVar, Union, cast
 
 from sqlalchemy import create_engine
@@ -42,6 +42,7 @@ def __init__(
         key_aliases: Optional[dict[str, list[str]]] = None,
         search_paths: Optional[dict[str, list[str]]] = None,
         key_handlers: Optional[dict[str, Callable[[Any, logging.LogRecord], Any]]] = None,
+        available_loggers: Optional[Sequence[str]] = None,
     ) -> None:
         super().__init__(level)
         self.model = model
@@ -52,6 +53,7 @@ def __init__(
         self.key_aliases = key_aliases or {}
         self.search_paths = search_paths or {}
         self.key_handlers = key_handlers or {}
+        self.available_loggers = set(available_loggers) if available_loggers else set()
 
     @property
     def loop(self) -> asyncio.AbstractEventLoop:
@@ -74,6 +76,9 @@ def construct_message(self, record: logging.LogRecord) -> T_:
 
     def emit(self, record: logging.LogRecord) -> None:
         """Save the message in the database."""
+        if self.available_loggers and record.name not in self.available_loggers:
+            return
+
         message = self.construct_message(record)
         if self.db_url.drivername == 'postgresql+asyncpg':
             self.loop.run_until_complete(self._async_emit(message))

fastapi_structlog/log.py

@@ -3,7 +3,7 @@
 import logging.handlers
 import sys
 from abc import abstractmethod
-from collections.abc import Callable
+from collections.abc import Callable, Sequence
 from logging.handlers import TimedRotatingFileHandler
 from pathlib import Path
 from queue import SimpleQueue
@@ -345,6 +345,7 @@ def create_handler(  # noqa: PLR0913
         key_aliases: Optional[dict[str, list[str]]] = None,
         search_paths: Optional[dict[str, list[str]]] = None,
         key_handlers: Optional[dict[str, Callable[[Any, logging.LogRecord], Any]]] = None,
+        available_loggers: Optional[Sequence[str]] = None,
         **_: Any,  # noqa: ANN401
     ) -> DatabaseHandler[T_]:
         """Create a handler."""
@@ -361,6 +362,7 @@ def create_handler(  # noqa: PLR0913
             key_aliases=key_aliases,
             search_paths=search_paths,
             key_handlers=key_handlers,
+            available_loggers=available_loggers,
         )
 
 

fastapi_structlog/middleware/structlog.py

@@ -43,7 +43,7 @@ async def __call__(self, scope: Scope, receive: Receive, send: Send) -> None:  #
             structlog.contextvars.bind_contextvars(request_id=request_id)
 
         request = {
-            'method': scope['method'],
+            'method': scope.get('method'),
             'path': get_path_with_query_string(scope),
             'client_addr': get_client_addr(scope),
             'user_agent': get_user_agent(scope),

fastapi_structlog/middleware/utils.py

@@ -30,6 +30,8 @@ def get_path_with_query_string(scope: Scope) -> str:
     Returns:
         str: URL with query parameters
     """
+    if 'path' not in scope:
+        return '-'
     path_with_query_string = quote(scope['path'])
     if raw_query_string := scope['query_string']:
         query_string = raw_query_string.decode('ascii')
@@ -46,6 +48,8 @@ def get_user_agent(scope: Scope) -> str:
     Returns:
         str: User-agent or '-' if it is not presented or for exceptions.
     """
+    if 'headers' not in scope:
+        return '-'
     headers: list[tuple[bytes, bytes]] = scope.get('headers')
     if not headers:
         return '-'