Structured Logging for Python¶
Release v19.1.0 (What’s new?).
structlog
makes logging in Python less painful and more powerful by adding structure to your log entries.
It’s up to you whether you want structlog
to take care about the output of your log entries or whether you prefer to forward them to an existing logging system like the standard library’s logging
module.
First steps:
- If you’re not sure whether
structlog
is for you, have a look at Why…. - If you can’t wait to log your first entry, start at Getting Started and then work yourself through the basic docs.
- Once you have basic grasp of how
structlog
works, acquaint yourself with the integrationsstructlog
is shipping with.
User’s Guide¶
Basics¶
Integration with Existing Systems¶
structlog
can be used immediately with any existing logger.
However it comes with special wrappers for the Python standard library and Twisted that are optimized for their respective underlying loggers and contain less magic.
Advanced Topics¶
API Reference¶
Getting Help¶
Please use the structlog
tag on StackOverflow to get help.
Answering questions of your fellow developers is also great way to help the project!
Project Information¶
structlog
is dual-licensed under Apache License, version 2 and MIT, available from PyPI, the source code can be found on GitHub, the documentation at https://www.structlog.org/.
structlog
targets Python 2.7, 3.4 and newer, and PyPy.