.. raw:: html


Documentation License: MIT / Apache 2.0 PyPI release

.. -begin-short-

structlog makes logging in Python faster, less painful, and more powerful by adding structure to your log entries. It has been successfully used in production at every scale since 2013, while embracing cutting-edge technologies like asyncio or type hints along the way, and influenced the design <https://twitter.com/sirupsen/status/638330548361019392>_ of structured logging packages in other ecosystems <https://github.com/sirupsen/logrus>_.

Thanks to its highly flexible design, 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.

.. image:: https://github.com/hynek/structlog/blob/main/docs/_static/console_renderer.png?raw=true

.. -end-short-

A short explanation on why structured logging is good for you, and why structlog is the right tool for the job can be found in the Why chapter <https://www.structlog.org/en/stable/why.html>_ of our documentation.

Once you feel inspired to try it out, check out our friendly Getting Started tutorial <https://www.structlog.org/en/stable/getting-started.html>_ that also contains detailed installation instructions!

If you prefer videos over reading, check out Markus Holtermann <https://twitter.com/m_holtermann>'s DjangoCon Europe 2019 talk: Logging Rethought 2: The Actions of Frank Taylor Jr. <https://www.youtube.com/watch?v=Y5eyEgyHLLo>

.. -begin-meta-

Getting Help

Please use the structlog tag on StackOverflow <https://stackoverflow.com/questions/tagged/structlog>_ to get help.

Answering questions of your fellow developers is also a great way to help the project!

Project Information

structlog is dual-licensed under Apache License, version 2 <https://choosealicense.com/licenses/apache/>_ and MIT <https://choosealicense.com/licenses/mit/>, available from PyPI <https://pypi.org/project/structlog/>, the source code can be found on GitHub <https://github.com/hynek/structlog>_, the documentation at https://www.structlog.org/.

We collect useful third-party extension in our wiki <https://github.com/hynek/structlog/wiki/Third-party-Extensions>_.

structlog targets Python 3.6 and later. PyPy3 is known to work, but is not tested anymore.

structlog for Enterprise

Available as part of the Tidelift Subscription.

The maintainers of structlog and thousands of other packages are working with Tidelift to deliver commercial support and maintenance for the open source packages you use to build your applications. Save time, reduce risk, and improve code health, while paying the maintainers of the exact packages you use. Learn more. <https://tidelift.com/subscription/pkg/pypi-structlog?utm_source=pypi-structlog&utm_medium=referral&utm_campaign=readme>_


Structured Logging for Python

Structlog Info

⭐ Stars 1915
🔗 Homepage www.structlog.org
🔗 Source Code github.com
🕒 Last Update 8 months ago
🕒 Created 9 years ago
🐞 Open Issues 27
➗ Star-Issue Ratio 71
😎 Author hynek