feat(v3)!: New logging experience

Makefile

@@ -121,12 +121,11 @@ check-all: lint test-all coverage                   ## Run all linting, tests, a
 # =============================================================================
 # Docs
 # =============================================================================
-# XXX: docs commands are pinned to Python 3.12 due to picologging not being compatible with 3.13
 
 .PHONY: docs-install
 docs-install: 										## Install docs dependencies
 	@echo "=> Installing documentation dependencies"
-	@uv sync --python 3.12 --group docs
+	@uv sync --group docs
 	@echo "=> Installed documentation dependencies"
 
 docs-clean: 										## Dump the existing built docs
@@ -136,16 +135,16 @@ docs-clean: 										## Dump the existing built docs
 
 docs-serve:  								## Serve the docs locally
 	@echo "=> Serving documentation"
-	uv run --isolated --python 3.12 sphinx-autobuild docs docs/_build/ -j auto --watch litestar --watch docs --watch tests --watch CONTRIBUTING.rst --open-browser --port=0
+	uv run --isolated sphinx-autobuild docs docs/_build/ -j auto --watch litestar --watch docs --watch tests --watch CONTRIBUTING.rst --open-browser --port=0
 
 docs: docs-clean 									## Dump the existing built docs and rebuild them
 	@echo "=> Building documentation"
-	@uv run --isolated --python 3.12 sphinx-build -M html docs docs/_build/ -E -a -j auto -W --keep-going
+	@uv run --isolated sphinx-build -M html docs docs/_build/ -E -a -j auto -W --keep-going
 
 .PHONY: docs-linkcheck
 docs-linkcheck: 									## Run the link check on the docs
-	@uv run --isolated --python 3.12 sphinx-build -b linkcheck ./docs ./docs/_build -D linkcheck_ignore='http://.*','https://.*'
+	@uv run --isolated sphinx-build -b linkcheck ./docs ./docs/_build -D linkcheck_ignore='http://.*','https://.*'
 
 .PHONY: docs-linkcheck-full
 docs-linkcheck-full: 									## Run the full link check on the docs
-	@uv run --isolated --python 3.12 sphinx-build -b linkcheck ./docs ./docs/_build -D linkcheck_anchors=0
+	@uv run --isolated sphinx-build -b linkcheck ./docs ./docs/_build -D linkcheck_anchors=0

docs/conf.py

@@ -62,7 +62,6 @@
     "alembic": ("https://alembic.sqlalchemy.org/en/latest/", None),
     "click": ("https://click.palletsprojects.com/en/latest/", None),
     "redis": ("https://redis.readthedocs.io/en/stable/", None),
-    "picologging": ("https://microsoft.github.io/picologging/", None),
     "structlog": ("https://www.structlog.org/en/stable/", None),
     "tortoise": ("https://tortoise.github.io/", None),
     "piccolo": ("https://piccolo-orm.readthedocs.io/en/latest/", None),
@@ -261,6 +260,12 @@
     re.compile(r"litestar\.channels\.backends\.asyncpg.*"): {"asyncpg.connection.Connection", "asyncpg.Connection"},
     re.compile(r"litestar\.handlers\.websocket_handlers\.stream.*"): {"WebSocketMode"},
     re.compile(r"litestar\.file_system.*"): {"AnyFileSystem", "SymlinkResolver"},
+    # these exist in struclog, but Sphinx thinks they're classes which they are not; they are type aliases
+    re.compile(r"litestar\.logging\.structlog\.StructLoggingConfig"): {
+        "structlog.typing.Processor",
+        "structlog.typing.Context",
+        "structlog.typing.WrappedLogger",
+    },
 }
 
 # Do not warn about broken links to the following:

docs/examples/middleware/logging_middleware.py

@@ -1,17 +1,19 @@
 from litestar import Litestar, get
 from litestar.logging.config import LoggingConfig
-from litestar.middleware.logging import LoggingMiddlewareConfig
+from litestar.middleware.logging import LoggingMiddleware
 
-logging_middleware_config = LoggingMiddlewareConfig()
 
-
-@get("/", sync_to_thread=False)
-def my_handler() -> dict[str, str]:
+@get("/")
+async def my_handler() -> dict[str, str]:
     return {"hello": "world"}
 
 
 app = Litestar(
     route_handlers=[my_handler],
     logging_config=LoggingConfig(),
-    middleware=[logging_middleware_config.middleware],
+    middleware=[
+        LoggingMiddleware(
+            request_log_fields=("query", "body"),  # only log query and body fields
+        )
+    ],
 )

docs/getting-started.rst

@@ -35,10 +35,7 @@ Installation
     :doc:`RedisStore </usage/stores>`
         :code:`pip install 'litestar[redis]'`
 
-    :ref:`Picologging <usage/logging:using picologging>`
-        :code:`pip install 'litestar[picologging]'`
-
-    :ref:`StructLog <usage/logging:using structlog>`
+    :ref:`StructLog <usage/logging:Structlog integration>`
         :code:`pip install 'litestar[structlog]'`
 
     :doc:`Prometheus Instrumentation </usage/metrics/prometheus>`

docs/reference/logging/index.rst

@@ -5,5 +5,4 @@ logging
     :titlesonly:
 
     config
-    picologging
-    standard
+    structlog

docs/reference/logging/structlog.rst

@@ -0,0 +1,5 @@
+structlog
+=========
+
+.. automodule:: litestar.logging.structlog
+    :members:

docs/reference/plugins/index.rst

@@ -15,4 +15,3 @@ plugins
     problem_details
     prometheus
     pydantic
-    structlog

docs/release-notes/2.x-changelog.rst

@@ -409,7 +409,7 @@
         :type: feature
         :pr: 2969
 
-        The option :attr:`~litestar.logging.config.LoggingConfig.configure_root_logger` was
+        The option ``litestar.logging.config.LoggingConfig.configure_root_logger`` was
         added to :class:`~litestar.logging.config.LoggingConfig` attribute. It is enabled by
         default to not implement a breaking change.
 

docs/release-notes/whats-new-2.rst

@@ -97,11 +97,11 @@ Imports
 +----------------------------------------------------+------------------------------------------------------------------------+
 | ``starlite.TemplateConfig``                        | :class:`.template.TemplateConfig`                                      |
 +----------------------------------------------------+------------------------------------------------------------------------+
-| ``starlite.BaseLoggingConfig``                     | :class:`.logging.config.BaseLoggingConfig`                             |
+| ``starlite.BaseLoggingConfig``                     | ``litestar.logging.config.BaseLoggingConfig``                          |
 +----------------------------------------------------+------------------------------------------------------------------------+
 | ``starlite.LoggingConfig``                         | :class:`.logging.config.LoggingConfig`                                 |
 +----------------------------------------------------+------------------------------------------------------------------------+
-| ``starlite.StructLoggingConfig``                   | :class:`.logging.config.StructLoggingConfig`                           |
+| ``starlite.StructLoggingConfig``                   | ``litestar.logging.config.StructLoggingConfig``                        |
 +----------------------------------------------------+------------------------------------------------------------------------+
 | **Provide**                                                                                                                 |
 +----------------------------------------------------+------------------------------------------------------------------------+