Merge pull request #70 from community-of-python/allow-turning-off-logging-middleware

allow turning off logging middleware

Author: lesnik512

README.md

@@ -397,6 +397,7 @@ class YourSettings(BaseServiceSettings):
     logging_unset_handlers: list[str] = ["uvicorn", "uvicorn.access"]
     logging_extra_processors: list[typing.Any] = []
     logging_exclude_endpoints: list[str] = []
+    logging_turn_off_middleware: bool = False
 ```
 
 Parameters description:
@@ -407,6 +408,7 @@ Parameters description:
 - `logging_unset_handlers` - Unset logger handlers.
 - `logging_extra_processors` - Set additional structlog processors if needed.
 - `logging_exclude_endpoints` - Exclude logging on specific endpoints.
+- `logging_turn_off_middleware` - Turning off logging middleware.
 
 ### CORS
 

microbootstrap/bootstrappers/fastapi.py

@@ -100,9 +100,10 @@ def bootstrap_after(self, application: ApplicationT) -> ApplicationT:
 @FastApiBootstrapper.use_instrument()
 class FastApiLoggingInstrument(LoggingInstrument):
     def bootstrap_after(self, application: ApplicationT) -> ApplicationT:
-        application.add_middleware(  # type: ignore[call-arg]
-            build_fastapi_logging_middleware(self.instrument_config.logging_exclude_endpoints),  # type: ignore[arg-type]
-        )
+        if not self.instrument_config.logging_turn_off_middleware:
+            application.add_middleware(  # type: ignore[call-arg]
+                build_fastapi_logging_middleware(self.instrument_config.logging_exclude_endpoints),  # type: ignore[arg-type]
+            )
         return application
 
 

microbootstrap/bootstrappers/litestar.py

@@ -118,6 +118,9 @@ def bootstrap_before(self) -> dict[str, typing.Any]:
 @LitestarBootstrapper.use_instrument()
 class LitestarLoggingInstrument(LoggingInstrument):
     def bootstrap_before(self) -> dict[str, typing.Any]:
+        if self.instrument_config.logging_turn_off_middleware:
+            return {}
+
         return {"middleware": [build_litestar_logging_middleware(self.instrument_config.logging_exclude_endpoints)]}
 
 

microbootstrap/instruments/logging_instrument.py

@@ -126,6 +126,7 @@ class LoggingConfig(BaseInstrumentConfig):
         default_factory=lambda: ["uvicorn", "uvicorn.access"],
     )
     logging_exclude_endpoints: list[str] = pydantic.Field(default_factory=list)
+    logging_turn_off_middleware: bool = False
 
 
 class LoggingInstrument(Instrument[LoggingConfig]):

tests/bootstrappers/test_litestar.py

@@ -2,6 +2,7 @@
 from unittest.mock import MagicMock
 
 import litestar
+import pytest
 from litestar import status_codes
 from litestar.middleware.base import MiddlewareProtocol
 from litestar.testing import AsyncTestClient
@@ -13,11 +14,14 @@
 from microbootstrap.bootstrappers.fastapi import FastApiBootstrapper  # noqa: F401
 
 
-async def test_litestar_configure_instrument() -> None:
+@pytest.mark.parametrize("logging_turn_off_middleware", [True, False])
+async def test_litestar_configure_instrument(logging_turn_off_middleware: bool) -> None:
     test_metrics_path: typing.Final = "/test-metrics-path"
 
     application: typing.Final = (
-        LitestarBootstrapper(LitestarSettings())
+        LitestarBootstrapper(
+            LitestarSettings(logging_turn_off_middleware=logging_turn_off_middleware, service_debug=False)
+        )
         .configure_instrument(
             LitestarPrometheusConfig(prometheus_metrics_path=test_metrics_path),
         )