structlog v22.1.0 Release Notes

Release Date: 2022-07-20 // 7 months ago
  • โœ‚ 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

Previous changes from v21.5.0

  • 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>_