All Versions
28
Latest Version
Avg Release Cycle
140 days
Latest Release
201 days ago

Changelog History
Page 1

  • v22.1.0 Changes

    July 20, 2022

    โœ‚ Removed

    • ๐Ÿ‘ Python 3.6 is not supported anymore.
    • Pickling is now only possible with protocol version 3 and newer.

    ๐Ÿ—„ Deprecated

    • ๐Ÿ—„ The entire structlog.threadlocal module is deprecated. Please use the primitives from structlog.contextvars instead.

    If you're using the modern APIs (bind_threadlocal() / merge_threadlocal()) it's enough to replace them 1:1 with their contextvars counterparts. The old approach around wrap_dict() has been discouraged for a while.

    Currently there are no concrete plans to remove the module, but no patches against it will be accepted from now on. #409

    โž• Added

    • โž• structlog.processors.StackInfoRenderer now has an additional_ignores parameter that allows you to filter out your own logging layer. #396
    • โž• Added structlog.WriteLogger, a faster โ€“ but more low-level โ€“ alternative to structlog.PrintLogger. It works the way PrintLogger used to work in previous versions. #403 #404
    • structlog.make_filtering_bound_logger()-returned loggers now also have a log() method to match the structlog.stdlib.BoundLogger signature closer. #413
    • โž• Added structured logging of tracebacks via the structlog.tracebacks module, and most notably the structlog.tracebacks.ExceptionDictTransformer which can be used with the new structlog.processors.ExceptionRenderer to render JSON tracebacks. #407
    • 0๏ธโƒฃ structlog.stdlib.recreate_defaults(log_level=logging.NOTSET) that recreates structlog's defaults on top of standard library's logging. It optionally also configures logging to log to standard out at the passed log level. #428
    • structlog.processors.EventRenamer allows you to rename the hitherto hard-coded event dict key event to something else. Optionally, you can rename another key to event at the same time, too. So adding EventRenamer(to="msg", replace_by="_event") to your processor pipeline will rename the standard event key to msg and then rename the _event key to event. This allows you to use the event key in your own log files and to have consistent log message keys across languages.
    • ๐ŸŒฒ structlog.dev.ConsoleRenderer(event_key="event") now allows to customize the name of the key that is used for the log message.

    ๐Ÿ”„ Changed

    • structlog.make_filtering_bound_logger() now returns a method with the same signature for all log levels, whether they are active or not. This ensures that invalid calls to inactive log levels are caught immediately and don't explode once the log level changes. #401
    • 0๏ธโƒฃ structlog.PrintLogger โ€“ that is used by default โ€“ now uses print() for printing, making it a better citizen for interactive terminal applications. #399
    • โœ… structlog.testing.capture_logs now works for already initialized bound loggers. #408
    • structlog.processors.format_exc_info() is no longer a function, but an instance of structlog.processors.ExceptionRenderer. Its behavior has not changed. #407
    • ๐Ÿ”ง The default configuration now includes the structlog.contextvars.merge_contextvars processor. That means you can use structlog.contextvars features without configuring structlog.

    ๐Ÿ›  Fixed

    • ๐Ÿ“„ Overloaded the bind, unbind, try_unbind and new methods in the FilteringBoundLogger Protocol. This makes it easier to use objects of type FilteringBoundLogger in a typed context. #392
    • 0๏ธโƒฃ Monkeypatched sys.stdouts are now handled more gracefully by ConsoleRenderer (that's used by default). #404
    • structlog.stdlib.render_to_log_kwargs() now correctly handles the presence of exc_info, stack_info, and stackLevel in the event dictionary. They are transformed into proper keyword arguments instead of putting them into the extra dictionary. #424, #427
  • v21.5.0 Changes

    December 16, 2021

    Backward-incompatible changes:

    none

    ๐Ÿ—„ Deprecations: ^

    none

    ๐Ÿ”„ Changes: ^

    • โž• Added the structlog.processors.LogfmtRenderer processor to render log lines using the logfmt <https://brandur.org/logfmt>_ format. #376 <https://github.com/hynek/structlog/pull/376>_
    • โž• Added the structlog.stdlib.ExtraAdder processor that adds extra attributes of logging.LogRecord objects to the event dictionary. This processor can be used for adding data passed in the extra parameter of the logging module's log methods to the event dictionary. #209 <https://github.com/hynek/structlog/pull/209>_ #377 <https://github.com/hynek/structlog/pull/377>_
    • โž• Added the structlog.processor.CallsiteParameterAdder processor that adds parameters of the callsite that an event dictionary orginated from to the event dictionary. This processor can be used to enrich events dictionaries with information such as the function name, line number and filename that an event dictionary orignated from. #380 <https://github.com/hynek/structlog/pull/380>_

  • v21.4.0 Changes

    November 25, 2021

    Backward-incompatible changes:

    none

    ๐Ÿ—„ Deprecations: ^

    none

    ๐Ÿ”„ Changes: ^

    • ๐Ÿ›  Fixed import when running in optimized mode (PYTHONOPTIMIZE=2 or python -OO). #373 <https://github.com/hynek/structlog/pull/373>_
    • Added the structlog.threadlocal.bound_threadlocal and structlog.contextvars.bound_contextvars decorator/context managers to temporarily bind key/value pairs to a thread-local and context-local context. #371 <https://github.com/hynek/structlog/pull/371>_

  • v21.3.0 Changes

    November 20, 2021

    Backward-incompatible changes:

    • structlog switched its packaging to flit <https://flit.readthedocs.io/>_. Users shouldn't notice a difference, but (re-)packagers might.

    ๐Ÿ—„ Deprecations: ^

    none

    ๐Ÿ”„ Changes: ^

    • structlog.dev.ConsoleRenderer now has sort_keys boolean parameter that allows to disable the sorting of keys on output. #358 <https://github.com/hynek/structlog/pull/358>_
    • ๐Ÿ”ง structlog.processors.TimeStamper now works well with FreezeGun even when it gets applied before the loggers are configured. #364 <https://github.com/hynek/structlog/pull/364>_
    • ๐ŸŒฒ structlog.stdlib.AsyncBoundLogger now determines the running loop when logging, not on instantiation. That has a minor performance impact, but makes it more robust when loops change (e.g. aiohttp.web.run_app()), or you want to use sync_bl before a loop has started.
    • ๐Ÿ–จ structlog.stdlib.ProcessorFormatter now has a processors argument that allows to define a processor chain to run over all log entries.

    Before running the chain, two additional keys are added to the event dictionary: _record and _from_structlog. With them it's possible to extract information from logging.LogRecord\s and differentiate between structlog and logging log entries while processing them.

    The old processor (singular) parameter is now deprecated, but no plans exist to remove it. #365 <https://github.com/hynek/structlog/pull/365>_


  • v21.2.0 Changes

    October 12, 2021

    Backward-incompatible changes:

    • ๐Ÿ‘€ To implement pretty exceptions (see Changes below), structlog.dev.ConsoleRenderer now formats exceptions itself.

    Make sure to remove format_exc_info from your processor chain if you configure structlog manually. This change is not really breaking, because the old use-case will keep working as before. However if you pass pretty_exceptions=True (which is the default if either rich or better-exceptions is installed), a warning will be raised and the exception will be renderered without prettyfication.

    ๐Ÿ—„ Deprecations: ^

    none

    ๐Ÿ”„ Changes: ^

    • structlog is now importable if sys.stdout is None (e.g. when running using pythonw). #313 <https://github.com/hynek/structlog/issues/313>_
    • structlog.threadlocal.get_threadlocal() and structlog.contextvars.get_contextvars() can now be used to get a copy of the current thread-local/context-local context that has been bound using structlog.threadlocal.bind_threadlocal() and structlog.contextvars.bind_contextvars(). #331 <https://github.com/hynek/structlog/pull/331>_ #337 <https://github.com/hynek/structlog/pull/337>_
    • ๐Ÿ”€ structlog.threadlocal.get_merged_threadlocal(bl) and structlog.contextvars.get_merged_contextvars(bl) do the same, but also merge the context from a bound logger bl. Same pull requests as previous change.
    • structlog.contextvars.bind_contextvars() now returns a mapping of keys to contextvars.Token\s, allowing you to reset values using the new structlog.contextvars.reset_contextvars(). #339 <https://github.com/hynek/structlog/pull/339>_
    • ๐Ÿ”ง Exception rendering in structlog.dev.ConsoleLogger is now configurable using the exception_formatter setting. If either the rich <https://github.com/willmcgugan/rich>_ or the better-exceptions <https://github.com/qix-/better-exceptions>_ package is present, structlog will use them for pretty-printing tracebacks. rich takes precedence over better-exceptions if both are present.

    This only works if format_exc_info is absent in the processor chain. #330 <https://github.com/hynek/structlog/pull/330>_ #349 <https://github.com/hynek/structlog/pull/349>_

    • ๐Ÿ All use of colorama on non-Windows systems has been excised. Thus, colors are now enabled by default in structlog.dev.ConsoleRenderer on non-Windows systems. You can keep using colorama to customize colors, of course. #345 <https://github.com/hynek/structlog/pull/345>_
    • The final processor can now return a bytearray (additionally to str and bytes). #344 <https://github.com/hynek/structlog/issues/344>_

  • v21.1.0 Changes

    February 18, 2021

    Backward-incompatible changes:

    none

    ๐Ÿ—„ Deprecations: ^

    none

    ๐Ÿ”„ Changes: ^

    • structlog.threadlocal.wrap_dict() now has a correct type annotation. #290 <https://github.com/hynek/structlog/pull/290>_
    • ๐Ÿ›  Fix isolation in structlog.contextvars. #302 <https://github.com/hynek/structlog/pull/302>_
    • ๐Ÿ”ง The default configuration and loggers are pickleable again. #301 <https://github.com/hynek/structlog/pull/301>_
    • structlog.dev.ConsoleRenderer will now look for a logger_name key if no logger key is set. #295 <https://github.com/hynek/structlog/pull/295>_

  • v20.2.0 Changes

    December 31, 2020

    Backward-incompatible changes:

    • ๐Ÿ‘ Python 2.7 and 3.5 aren't supported anymore. The package meta data should ensure that you keep getting 20.1.0 on those versions. #244 <https://github.com/hynek/structlog/pull/244>_

    • structlog is now fully type-annotated. This won't break your applications, but if you use Mypy, it will most likely break your CI.

    Check out the new chapter on typing for details.

    • ๐Ÿ”ง The default bound logger (wrapper_class) if you don't configure structlog has changed. It's mostly compatible with the old one but a few uncommon methods like log, failure, or err don't exist anymore.

    You can regain the old behavior by using structlog.configure(wrapper_class=structlog.BoundLogger).

    Please note that due to the various interactions between settings, it's possible that you encounter even more errors. We strongly urge you to always configure all possible settings since the default configuration is not covered by our backward compatibility policy <https://www.structlog.org/en/stable/backward-compatibility.html>_.

    ๐Ÿ—„ Deprecations: ^

    • ๐Ÿ—„ Accessing the _context attribute of a bound logger is now deprecated. Please use the new structlog.get_context().

    ๐Ÿ”„ Changes: ^

    • structlog has now type hints for all of its APIs! Since structlog is highly dynamic and configurable, this led to a few concessions like a specialized structlog.stdlib.get_logger() whose only difference to structlog.get_logger() is that it has the correct type hints.

    We consider them provisional for the time being โ€“ i.e. the backward compatibility does not apply to them in its full strength until we feel we got it right. Please feel free to provide feedback! #223 <https://github.com/hynek/structlog/issues/223>, #282 <https://github.com/hynek/structlog/issues/282>

    • Added structlog.make_filtering_logger that can be used like configure(wrapper_class=make_filtering_bound_logger(logging.INFO)). It creates a highly optimized bound logger whose inactive methods only consist of a return None. This is now also the default logger.
    • ๐ŸŒฒ As a complement, structlog.stdlib.add_log_level() can now additionally be imported as structlog.processors.add_log_level since it just adds the method name to the event dict.
    • ๐ŸŒฒ structlog.processors.add_log_level() is now part of the default configuration.
    • structlog.stdlib.ProcessorFormatter no longer uses exceptions for control flow, allowing foreign_pre_chain processors to use sys.exc_info() to access the real exception.
    • โž• Added structlog.BytesLogger to avoid unnecessary encoding round trips. Concretely this is useful with orjson which returns bytes. #271 <https://github.com/hynek/structlog/issues/271>_
    • The final processor now also may return bytes that are passed untouched to the wrapped logger.
    • structlog.get_context() allows you to retrieve the original context of a bound logger. #266 <https://github.com/hynek/structlog/issues/266>_,
    • ๐Ÿ–จ structlog.PrintLogger now supports copy.deepcopy(). #268 <https://github.com/hynek/structlog/issues/268>_
    • โž• Added structlog.testing.CapturingLogger for more unit testing goodness.
    • โž• Added structlog.stdlib.AsyncBoundLogger that executes logging calls in a thread executor and therefore doesn't block. #245 <https://github.com/hynek/structlog/pull/245>_

  • v20.1.0 Changes

    January 28, 2020

    Backward-incompatible changes:

    none

    ๐Ÿ—„ Deprecations: ^

    • ๐Ÿ‘ This is the last version to support Python 2.7 (including PyPy) and 3.5. All following versions will only support Python 3.6 or later.

    ๐Ÿ”„ Changes: ^

    • โž• Added a new module structlog.contextvars that allows to have a global but context-local structlog context the same way as with structlog.threadlocal since 19.2.0. #201 <https://github.com/hynek/structlog/issues/201>, #236 <https://github.com/hynek/structlog/pull/236>
    • โž• Added a new module structlog.testing for first class testing support. The first entry is the context manager capture_logs() that allows to make assertions about structured log calls. #14 <https://github.com/hynek/structlog/issues/14>, #234 <https://github.com/hynek/structlog/pull/234>
    • โž• Added structlog.threadlocal.unbind_threadlocal(). #239 <https://github.com/hynek/structlog/pull/239>_
    • The logger created by structlog.get_logger() is not detected as an abstract method anymore, when attached to an abstract base class. #229 <https://github.com/hynek/structlog/issues/229>_
    • ๐Ÿ colorama isn't initialized lazily on Windows anymore because it breaks rendering. #232 <https://github.com/hynek/structlog/issues/232>, #242 <https://github.com/hynek/structlog/pull/242>

  • v19.2.0 Changes

    October 16, 2019

    Backward-incompatible changes:

    • ๐Ÿ‘ Python 3.4 is not supported anymore. It has been unsupported by the Python core team for a while now and its PyPI downloads are negligible.

    It's very unlikely that structlog will break under 3.4 anytime soon, but we don't test it anymore.

    ๐Ÿ—„ Deprecations: ^

    none

    ๐Ÿ”„ Changes: ^

    • ๐Ÿ‘ Full Python 3.8 support for structlog.stdlib.
    • โž• Added more pass-through properties to structlog.stdlib.BoundLogger. To makes it easier to use it as a drop-in replacement for logging.Logger. #198 <https://github.com/hynek/structlog/issues/198>_
    • structlog.stdlib.ProcessorFormatter now takes a logger object as an optional keyword argument. This makes ProcessorFormatter work properly with stuctlog.stdlib.filter_by_level(). #219 <https://github.com/hynek/structlog/issues/219>_
    • 0๏ธโƒฃ structlog.dev.ConsoleRenderer now uses no colors by default, if colorama is not available. #215 <https://github.com/hynek/structlog/issues/215>_
    • structlog.dev.ConsoleRenderer now initializes colorama lazily, to prevent accidental side-effects just by importing structlog. #210 <https://github.com/hynek/structlog/issues/210>_
    • Added new processor structlog.dev.set_exc_info() that will set exc_info=True if the method's name is exception and exc_info isn't set at all. This is only necessary when the standard library integration is not used. It fixes the problem that in the default configuration, structlog.get_logger().exception("hi") in an except block would not print the exception without passing exc_info=True to it explicitly. #130 <https://github.com/hynek/structlog/issues/130>, #173 <https://github.com/hynek/structlog/issues/173>, #200 <https://github.com/hynek/structlog/issues/200>, #204 <https://github.com/hynek/structlog/issues/204>
    • A best effort has been made to make as much of structlog pickleable as possible to make it friendlier with multiprocessing and similar libraries. Some classes can only be pickled on Python 3 or using the dill <https://pypi.org/project/dill/>_ library though and that is very unlikely to change.

    So far, the configuration proxy, structlog.processor.TimeStamper, structlog.BoundLogger, structlog.PrintLogger and structlog.dev.ConsoleRenderer have been made pickelable. Please report if you need any another class fixed. #126 <https://github.com/hynek/structlog/issues/126>_

    • โž• Added a new thread-local API that allows binding values to a thread-local context explicitly without affecting the default behavior of bind(). #222 <https://github.com/hynek/structlog/issues/222>, #225 <https://github.com/hynek/structlog/issues/225>
    • Added pass_foreign_args argument to structlog.stdlib.ProcessorFormatter. It allows to pass a foreign log record's args attribute to the event dictionary under the positional_args key. #228 <https://github.com/hynek/structlog/issues/228>_
    • structlog.dev.ConsoleRenderer now calls str() on the event value. #221 <https://github.com/hynek/structlog/issues/221>_

  • v19.1.0 Changes

    February 02, 2019

    Backward-incompatible changes:

    • As announced in 18.1.0, pip install -e .[dev] now installs all development dependencies. Sorry for the inconveniences this undoubtedly will cause!

    ๐Ÿ—„ Deprecations: ^

    none

    ๐Ÿ”„ Changes: ^

    • ๐Ÿ–จ structlog.ReturnLogger and structlog.PrintLogger now have a fatal() log method. #181 <https://github.com/hynek/structlog/issues/181>_
    • ๐Ÿ‘ป Under certain (rather unclear) circumstances, the frame extraction could throw an SystemError: error return without exception set. A workaround has been added. #174 <https://github.com/hynek/structlog/issues/174>_
    • ๐ŸŒฒ structlog now tolerates passing through dict\ s to stdlib logging. #187 <https://github.com/hynek/structlog/issues/187>, #188 <https://github.com/hynek/structlog/pull/188>, #189 <https://github.com/hynek/structlog/pull/189>_