Structured Logging for Python

Release v22.1.0 (What's new?)

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 of structured logging packages in other ecosystems.

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.

structlog comes with support for JSON, logfmt, as well as pretty console output out-of-the-box:

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 integrations structlog is shipping with.

User’s Guide

Basics

• Why…
• Getting Started
• Loggers
• Configuration
• Testing
• Context Variables
• Processors
• Examples
• Development
• Type Hints

Integration with Existing Systems

structlog can be used immediately with any existing logger, or with the one with that it ships. 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.

• Standard Library Logging
• Twisted
• Logging Best Practices

Advanced Topics

• Custom Wrappers
• Performance
• Legacy Thread-local Context

API Reference

• API Reference
  • structlog Package
  • structlog.dev Module
  • structlog.testing Module
  • structlog.contextvars Module
  • structlog.threadlocal Module
  • structlog.processors Module
  • structlog.stdlib Module
  • structlog.tracebacks Module
  • structlog.types Module
  • structlog.twisted Module

Project Information

• License: dual Apache License, version 2 and MIT

• PyPI: https://pypi.org/project/structlog/

• Source Code: https://github.com/hynek/structlog

• Documentation: https://www.structlog.org/

• Changelog: https://www.structlog.org/en/stable/changelog.html

• Get Help: please use the structlog tag on StackOverflow

• Third-party Extensions: https://github.com/hynek/structlog/wiki/Third-party-Extensions

• Supported Python Versions: 3.7 and later

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.

Indices and tables

• Index

• Module Index