feat(v3)!: New logging experience by provinzkraut · Pull Request #4593 · litestar-org/litestar

provinzkraut · 2026-02-11T20:07:24Z

Still need to clean up some things to reduce unnecessary breaking changes, but feature wise, everything is there.

Remove global Litestar logging config; Litestar now only configures its own logging
Simplify structlog integration
Remove structlog plugin (not necessary anymore)
Don't configure structlog globalls
Remove picologging
Simplify logging configuration
Simplify logging middleware configuration
Unify logging config / logging middleware config
Improve testing integration (behave nicely with caplog / structlogs capture_logs)
Better docs

codecov · 2026-02-11T20:34:00Z

Codecov Report

❌ Patch coverage is 93.81443% with 12 lines in your changes missing coverage. Please review.
✅ Project coverage is 97.79%. Comparing base (2af0305) to head (c4d3f28).

Files with missing lines	Patch %	Lines
litestar/logging/config.py	93.05%	1 Missing and 4 partials ⚠️
litestar/logging/structlog.py	94.20%	1 Missing and 3 partials ⚠️
litestar/middleware/logging.py	93.93%	0 Missing and 2 partials ⚠️
litestar/app.py	88.88%	0 Missing and 1 partial ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #4593      +/-   ##
==========================================
- Coverage   97.85%   97.79%   -0.06%     
==========================================
  Files         297      294       -3     
  Lines       15339    15200     -139     
  Branches     1721     1715       -6     
==========================================
- Hits        15010    14865     -145     
- Misses        188      190       +2     
- Partials      141      145       +4

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Kumzy

In the test_apps/logging_test_app in main.py line 3, the import is no longer correct too?

I think it's missing some tests on ExtraKeyValueFormatter for the litestar/logging/config.py

docs/usage/logging.rst

Kumzy · 2026-02-12T09:11:29Z

litestar/config/app.py

    """A list of :class:`EventListener <.events.listener.EventListener>`."""
-    logging_config: BaseLoggingConfig | None = field(default=None)
-    """An instance of :class:`BaseLoggingConfig <.logging.config.BaseLoggingConfig>` subclass."""
+    logging_config: LoggingConfig = field(default_factory=LoggingConfig)


We can no longer pass None to this to disable the logging config?

my app on this branch uses Litestar(logging_config=None) and I didnt have any errors

Mhm. I think that's just an oversight in the typing. I'll check on that

I think there are some performance implications here. IIRC, using None here can improve performance in some cases.

We should probably ensure the None remains an option here.

litestar/logging/__init__.py

litestar/app.py

Kumzy · 2026-02-12T09:17:01Z

litestar/app.py

    def debug(self) -> bool:
        return self._debug

-    @debug.setter


Is it intended so we can not change the debug status while the app is running or it was never working before?

It has never properly worked before

It's also very tricky to get right, because not all logging libraries work the same in regards of setting levels dynamically.

Kumzy · 2026-02-12T09:58:18Z

litestar/logging/structlog.py

+            return not self.pretty_print_tty
+        return True
+
+    def _get_structlog_config(self) -> dict[str, None]:


Litestar mostly use dict[str, Any] for returns type. It's the only line in the code where the returns is dict[str, None]. Is it intended?

Nope. Any I'm not sure why mypy isn't complaining about this 😅

cofin · 2026-02-18T22:47:17Z

litestar/logging/config.py

-    exception_logging_handler: ExceptionLoggingHandler | None
-    """Handler function for logging exceptions."""
-    disable_stack_trace: set[Union[int, type[Exception]]]  # noqa: UP007
+    disable_stack_trace: set[int | type[Exception]] = dataclasses.field(default_factory=set)


It would be nice to use this opportunity to set a few default exceptions to exclude from the stack trace.

I tend to always add the following default set to every application to cleanup logging output: {404, 401, 403, NotAuthorizedException, PermissionDeniedException}

cofin · 2026-02-18T22:48:16Z

litestar/logging/config.py

-    """This will be the configuration for the root logger.

-    Processing of the configuration will be as for any logger, except that the propagate setting will not be applicable.
+    always_propagate_on_pytest: bool = True


Nice addition!

cofin · 2026-02-18T22:53:40Z

Makefile

 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


I think we should consider leaving these pins in.

When i install the dev env, I typically use the lowest supported version for the library (3.10 in this case), but the latest versions of Sphinx have a minimum version of 3.12. We have been running into similar problems with the Advanced Alchemy docs.

I had a reason for unpinning this but I can't remember. I'll find out

provinzkraut added 15 commits February 11, 2026 19:51

get it working

cb66a0a

clean up config

472dc25

some refactoring

33d9c85

even more refactoring

7885749

formatting pass

039dc05

remove picologging

3e4f640

fix typing

d8ecbdf

alter default fields

394e9b5

docs

29b4b41

simplify logging extra passing

14aa068

typing + formatting

4b84c6f

remove picologging remnants

5bdf9d7

some testing tweaks

d214396

Add a note about structlog testing

252f977

typing fixes

486ad0d

provinzkraut marked this pull request as ready for review February 11, 2026 20:10

provinzkraut requested review from a team and JacobCoffee as code owners February 11, 2026 20:10

provinzkraut requested a review from a team as a code owner February 11, 2026 20:10

fix extras

c4d3f28

provinzkraut force-pushed the fix-logging branch from 597d75f to c4d3f28 Compare February 11, 2026 20:15

sobolevn mentioned this pull request Feb 12, 2026

Support logging wemake-services/django-modern-rest#502

Open

Kumzy reviewed Feb 12, 2026

View reviewed changes

cofin reviewed Feb 18, 2026

View reviewed changes

cofin mentioned this pull request Feb 18, 2026

fix(logging): emit log without stack trace when exception is in disable_stack_trace #4588

Open

Uh oh!

Conversation

provinzkraut commented Feb 11, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

codecov bot commented Feb 11, 2026

Codecov Report

Uh oh!

Kumzy left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Comments

provinzkraut commented Feb 11, 2026 •

edited

Loading

Kumzy left a comment •

edited

Loading