Skip to main content

Structured Logging for Python

Project description

structlog mascot

structlog is the production-ready logging solution for Python:

  • Simple: Everything is about functions that take and return dictionaries – all hidden behind familiar APIs.
  • Powerful: Functions and dictionaries aren’t just simple but also powerful. structlog leaves you in control.
  • Fast: structlog is not hamstrung by designs of yore. Its flexibility comes not at the price of performance.

Thanks to its flexible design, you choose whether you want structlog to take care of 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.

The output format is just as flexible and structlog comes with support for JSON, logfmt, as well as pretty console output out-of-the-box:

image

Sponsors

structlog would not be possible without our amazing sponsors. Especially those generously supporting us at the The Organization tier and higher:

Please consider joining them to help make structlog’s maintenance more sustainable!


structlog has been successfully used in production at every scale since 2013, while embracing cutting-edge technologies like asyncio, context variables, or type hints as they emerged. Its paradigms proved influential enough to help design structured logging packages across ecosystems.

Project Links

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.

Release Information

Added

  • Restore feature parity between structlog.traceback.ExceptionDictTransformer and Rich's traceback extractor:

    • When displaying locals, use Rich for formatting if it is available.
    • When displaying locals, call repr() on strings, too (improves handling of SecretStr implementations).
    • Add locals_max_length config option
    • Add locals_hide_sunder config option
    • Add locals_hide_dunder config option
    • Add suppress config option

    #627

Changed

  • structlog.testing.capture_logs() now maps the exception log level to error (as it's elsewhere). #628

Full Changelog →

Credits

structlog is written and maintained by Hynek Schlawack. The idea of bound loggers is inspired by previous work by Jean-Paul Calderone and David Reid.

The development is kindly supported by my employer Variomedia AG, structlog’s Tidelift subscribers, and all my amazing GitHub Sponsors.

The logs-loving beaver logo has been contributed by Lynn Root.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

structlog-24.3.0.tar.gz (1.3 MB view details)

Uploaded Source

Built Distribution

structlog-24.3.0-py3-none-any.whl (67.4 kB view details)

Uploaded Python 3

File details

Details for the file structlog-24.3.0.tar.gz.

File metadata

  • Download URL: structlog-24.3.0.tar.gz
  • Upload date:
  • Size: 1.3 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.0 CPython/3.12.4

File hashes

Hashes for structlog-24.3.0.tar.gz
Algorithm Hash digest
SHA256 bcf6b890cf8b48c35fa127ea79c155c79b9e6a4a826f4ce9dfc3bebd72f07fa8
MD5 5ec42010d2833c9e2a0f606a7dd50981
BLAKE2b-256 64b3b8b9ae47c3a964d7fa9bde7d89aa8ec3900978a2409c093e6c6290963316

See more details on using hashes here.

File details

Details for the file structlog-24.3.0-py3-none-any.whl.

File metadata

  • Download URL: structlog-24.3.0-py3-none-any.whl
  • Upload date:
  • Size: 67.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.0 CPython/3.12.4

File hashes

Hashes for structlog-24.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 ee4c2c7ef7971201f89f85893a4470ecd03bbd97bb54d75581225fdb894689a4
MD5 609830ec988d144c93fd67ac54d8e167
BLAKE2b-256 2a94e7673d2a714cca39315166a0735ec0aed17908aa36aa353dd5fea67cc53e

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page