Skip to main content
Join the official Python Developers Survey 2018 and win valuable prizes: Start the survey!

Structured Logging for Python

Project description

structlog Logo

structlog: Structured Logging for Python

Documentation Status Test Coverage

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.

Easier Logging

You can stop writing prose and start thinking in terms of an event that happens in the context of key/value pairs:

>>> from structlog import get_logger
>>> log = get_logger()
>>>"key_value_logging", out_of_the_box=True, effort=0)
2016-04-20 16:20.13 key_value_logging              effort=0 out_of_the_box=True

Each log entry is a meaningful dictionary instead of an opaque string now!

Data Binding

Since log entries are dictionaries, you can start binding and re-binding key/value pairs to your loggers to ensure they are present in every following logging call:

>>> log = log.bind(user="anonymous", some_key=23)
>>> log = log.bind(user="hynek", another_key=42)
>>>"user.logged_in", happy=True)
2016-04-20 16:20.13 user.logged_in                 another_key=42 happy=True some_key=23 user='hynek'

Powerful Pipelines

Each log entry goes through a processor pipeline that is just a chain of functions that receive a dictionary and return a new dictionary that gets fed into the next function. That allows for simple but powerful data manipulation:

def timestamper(logger, log_method, event_dict):
    """Add a timestamp to each log entry."""
    event_dict["timestamp"] = time.time()
    return event_dict

There are plenty of processors for most common tasks coming with structlog:


structlog is completely flexible about how the resulting log entry is emitted. Since each log entry is a dictionary, it can be formatted to any format:

  • A colorful key/value format for local development,
  • JSON for easy parsing,
  • or some standard format you have parsers for like nginx or Apache httpd.

Internally, formatters are processors whose return value (usually a string) is passed into loggers that are responsible for the output of your message. structlog comes with multiple useful formatters out of-the-box.


structlog is also very flexible with the final output of your log entries:

  • A built-in lightweight printer like in the examples above. Easy to use and fast.
  • Use the standard library’s or Twisted’s logging modules for compatibility. In this case structlog works like a wrapper that formats a string and passes them off into existing systems that won’t ever know that structlog even exists. Or the other way round: structlog comes with a logging formatter that allows for processing third party log records.
  • Don’t format it to a string at all! structlog passes you a dictionary and you can do with it whatever you want. Reported uses cases are sending them out via network or saving them in a database.

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

structlog targets Python 2.7, 3.4 and newer, and PyPy.

If you need any help, visit us on #structlog on Freenode!

Release Information

18.1.0 (2018-01-27)

Backward-incompatible changes:



  • The meaning of the structlog[dev] installation target will change from “colorful output” to “dependencies to develop structlog” in 19.1.0.

    The main reason behind this decision is that it’s impossible to have a structlog in your normal dependencies and additionally a structlog[dev] for developement (pip will report an error).


  • Empty strings are valid events now. #110
  • Do not encapsulate Twisted failures twice with newer versions of Twisted. #144
  • now accepts a force_colors argument to output colored logs even if the destination is not a tty. Use this option if your logs are stored in files that are intended to be streamed to the console.
  • now accepts a level_styles argument for overriding the colors for individual levels, as well as to add new levels. See the docs for ConsoleRenderer.get_default_level_styles() for usage. #139
  • structlog.stdlib.BoundLogger.exception() now uses the exc_info argument if it has been passed instead of setting it unconditionally to True. #149
  • Default configuration now uses plain dicts on Python 3.6+ and PyPy since they are ordered by default.
  • Added structlog.is_configured() to check whether or not structlog has been configured.
  • Added structlog.get_config() to introspect current configuration.

Full changelog.


structlog is written and maintained by Hynek Schlawack. It’s inspired by previous work done by Jean-Paul Calderone and David Reid.

The development is kindly supported by Variomedia AG.

A full list of contributors can be found on GitHub’s overview. Some of them disapprove of the addition of thread local context data. :)

The structlog logo has been contributed by Russell Keith-Magee.

Project details

Download files

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

Filename, size & hash SHA256 hash help File type Python version Upload date
structlog-18.1.0-py2.py3-none-any.whl (35.5 kB) Copy SHA256 hash SHA256 Wheel py2.py3 Jan 27, 2018
structlog-18.1.0.tar.gz (317.0 kB) Copy SHA256 hash SHA256 Source None Jan 27, 2018

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page