Simple. Powerful. Fast. Pick three.
Release {sub-ref}release (What's new?)
:start-after: <!-- begin-short -->
:end-before: <!-- end-short -->
If you’d like more information on why structured logging in general – and structlog in particular – are good ideas, we’ve prepared a summary just for you.
Otherwise, let’s dive right in!
:hidden: true
why
The first chapters teach you all you need to use structlog productively. They build gently on each other, so ideally, read them in order.
:maxdepth: 2
getting-started
bound-loggers
configuration
processors
contextvars
exceptions
structlog's focus is production systems, but it comes with pretty console logging and handy in-development helpers both for your comfort and your code's quality.
:maxdepth: 2
console-output
testing
typing
(integration)=
structlog is both zero-config as well as highly configurable. You can use it on its own or integrate with existing systems. Dedicated support for the standard library and Twisted is shipped out-of-the-box.
:maxdepth: 2
frameworks
standard-library
twisted
The following chapters deal with considerations of using structlog in the real world.
:maxdepth: 2
recipes
logging-best-practices
performance
:maxdepth: 1
thread-local
:maxdepth: 2
api
:start-after: "## Project Links"
% stop Sphinx from complaining about orphaned docs, we link them elsewhere
:hidden: true
license
- {any}
genindex - {any}
modindex