v25.1.0

Compare Source

Added

• Add structlog.stdlib.render_to_log_args_and_kwargs processor.
  Same as structlog.stdlib.render_to_log_kwargs, but also allows to pass positional arguments to logging.
  With it, you do not need to add structlog.stdlib.PositionalArgumentsFormatter processor to format positional arguments from structlog loggers.
  #​668

• Native loggers now have is_enabled_for() and get_effective_level() methods that mirror the behavior of the standard library's logging.Logger.isEnabledFor() and logging.Logger.getEffectiveLevel().
  #​689

Changed

• structlog.typing.BindableLogger protocol now returns Self instead of BindableLogger.
  This adds a dependency on typing-extensions for Pythons older than 3.11.
  #​642
  #​659

• structlog.dev.ConsoleRenderer will quote string value with special characters.
  #​647

• structlog.stdlib.recreate_defaults() now also adds structlog.stdlib.PositionalArgumentsFormatter.
  In default native mode, this is done by the loggers at the edge.

• structlog.make_filtering_bound_logger() now also accepts a string for min_level.

Fixed

• Fix handling calls to {logger}.exception() outside of exception blocks.
  Depending on the structlog configuration,
  this either resulted in an event dict key exception: "MISSING" or lead to an error.
  Now, an invalid or missing exc_info will just be ignored.
  This means, that calling {logger}.exception() outside of an exception block is basically the same as calling {logger}.error().
  #​634
  #​680

• Instantiating structlog.dev.ConsoleRenderer does not mutate the passed styles dict anymore.
  #​669

• The native FilteringBoundLogger.fatal() method now maps to the critical level, as it does in the standard library.
  Note that the level is discouraged to use there, so we recommend to stick to error() or critical().
  #​677

• structlog.tracebacks.ExceptionDictTransformer now actually accepts None for locals_max_length and locals_max_string.
  #​675

v24.4.0

Compare Source

Changed

No code changes since 24.3.0

v24.3.0

Compare Source

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

v24.2.0

Compare Source

Added

• It is now possible to disable log level-padding in structlog.dev.LogLevelColumnFormatter and structlog.dev.ConsoleRenderer.
  #​599

• The structlog.processors.CallsiteParameterAdder can now be pickled.
  #​603

• structlog.processors.CallsiteParameterAdder now also works with structlog.stdlib.BoundLogger's non-standard async methods (ainfo(), and so forth)
  #​618

Changed

• structlog.processors.LogfmtRenderer now escapes newlines.
  #​592

• structlog.processors.LogfmtRenderer now escapes backslashes and double quotes.
  #​594

• structlog.processors.CallsiteParameterAdder has been optimized to be about 2x faster.
  #​606

Fixed

• structlog.stdlib.render_to_log_kwargs now correctly passes stacklevel as a kwarg to stdlib logging.
  #​619

v24.1.0

Compare Source

Fixed

• The lazy logger proxy returned by structlog.get_logger() now returns its initial values when asked for context.
  When asked for context before binding for the first time, it returned an empty dictionary in 23.3.0.

• The displayed level name when using structlog.stdlib.BoundLogger.exception() is "error" instead of "exception".
  Fixes regression in 23.3.0.
  #​584

• Don't ignore the width argument of RichTracebackFormatter.
  #​587

v23.3.0

Compare Source

Added

• The colorful development logger is now even more configurable!
  Choose freely your colors and the order of the key-value pairs!
  Implement your own formatters for certain keys!

  Implementing the output on top of the new columns API has changed the default very slightly, but shouldn't be noticeable.
  #​577

• Async log methods (those starting with an a) now also support the collection of callsite information using structlog.processors.CallsiteParameterAdder.
  #​565

Changed

• structlog.stdlib.recreate_defaults() now also adds structlog.stdlib.add_logger_name to the processors.
  Check out the updated screenshot!

Fixed

• The return value from get_logger() (a BoundLoggerLazyProxy) now passes isinstance-checks against structlog.typing.BindableLogger on Python 3.12.
  #​561

• structlog.threadlocal.tmp_bind() now also works with BoundLoggerLazyProxy (in other words: before anything is bound to a bound logger).

• stdlib: ProcessorFormatter can now be told to not render the log record message using getMessage and just str(record.msg) instead.
  #​550

• stdlib: structlog.stdlib.BoundLogger.exception()'s handling ofLogRecord.exc_info is now set consistent with logging.
  #​571
  #​572

v23.2.0

Compare Source

Removed

• Support for Python 3.7.

Added

• Official support for Python 3.12.
  #​515

• structlog.processors.MaybeTimeStamper that only adds a timestamp if there isn't one already.
  #​81

• structlog.dev.ConsoleRenderer now supports renamed timestamp keys using the timestamp_key parameter.
  #​541

• structlog.dev.RichTracebackFormatter that allows to configure the traceback formatting.
  #​542

Fixed

• FilteringBoundLogger.exception() and FilteringBoundLogger.aexception() now support positional argument formatting like the rest of the methods.
  #​531
• structlog.processors.format_exc_info() and structlog.dev.ConsoleRenderer do not crash anymore when told to format a non-existent exception.
  #​533

v23.1.0

Compare Source

Added

• structlog.stdlib.BoundLogger now has, analogously to our native logger, a full set of async log methods prefixed with an a: await log.ainfo("event!")
  #​502

• The default configuration now respects the presence of FORCE_COLOR (regardless of its value, unless an empty string).
  This disables all heuristics whether it makes sense to use colors.
  #​503

• The default configuration now respects the presence of NO_COLOR (regardless of its value, unless an empty string).
  This disables all heuristics whether it makes sense to use colors and overrides FORCE_COLOR.
  #​504

Fixed

• ConsoleRenderer now reuses the _figure_out_exc_info to process the exc_info argument like ExceptionRenderer does.
  This prevents crashes if the actual Exception is passed for the exc_info argument instead of a tuple or True.
  #​482

• FilteringBoundLogger.aexception() now extracts the exception info using sys.exc_info() before passing control to the asyncio executor (where original exception info is no longer available).
  #​488

v22.3.0

Compare Source

Changed

• String interpolation in FilteringBoundLogger (used by default) is now only attempted if positional arguments are passed.
  This prevents crashes if something different than a string is passed for the event argument.
  #​475

Fixed

• String interpolation doesn't cause crashes in filtered log call anymore.
  #​478

v22.2.0

Compare Source

Deprecated

• Accessing package metadata as attributes on the structlog module is deprecated (for example, structlog.__version__).
  Please use importlib.metadata instead (for Python 3.7: the importlib-metadata PyPI package).
• The structlog.types module is now deprecated in favor of the structlog.typing module.
  It seems like the Python typing community is settling on this name.

Added

• FilteringBoundLogger (used by default) now allows for string interpolation using positional arguments:

  >>> log.info("Hello %s! The answer is %d.", "World", 42, x=1)
  2022-10-07 10:04.31 [info     ] Hello World! The answer is 42. x=1

  #​454

• FilteringBoundLogger now also has support for asyncio-based logging.
  Instead of a wrapper class like structlog.stdlib.AsyncBoundLogger, async equivalents have been added for all logging methods.
  So instead of log.info("hello") you can also write await log.ainfo("hello") in async functions and methods.

  This seems like the better approach and if it's liked by the community, structlog.stdlib.BoundLogger will get those methods too.
  #​457

Changed

• The documentation has been heavily overhauled.
  Have a look if you haven't lately!
  Especially the graphs in the standard library chapter have proven valuable to many.
• The build backend has been switched to Hatch.

Fixed

• The timestamps in the default configuration now use the correct separator (:) for seconds.

v22.1.0

Compare Source

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

Compare Source

Added

• Added the structlog.processors.LogfmtRenderer processor to render log lines using the logfmt format.
  #​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,
  #​377
• Added the structlog.processor.CallsiteParameterAdder processor that adds parameters of the callsite that an event dictionary originated 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 originated from.
  #​380

v21.4.0

Compare Source

Added

• 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

Fixed

• Fixed import when running in optimized mode (PYTHONOPTIMIZE=2 or python -OO)
  .
  #​373

v21.3.0

Compare Source

Added

• structlog.dev.ConsoleRenderer now has sort_keys boolean parameter that allows to disable the sorting of keys on output.
  #​358

Changed

• structlog switched its packaging to flit.
  Users shouldn't notice a difference, but (re-)packagers might.
• 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 (for example, aiohttp.web.run_app()), or you want to use sync_bl before a loop has started.

Fixed

• structlog.processors.TimeStamper now works well with FreezeGun even when it gets applied before the loggers are configured.
  #​364

• 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.LogRecords 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

v21.2.0

Compare Source

Added

• 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,
  #​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.Tokens, allowing you to reset values using the new structlog.contextvars.reset_contextvars().
  #​339

• Exception rendering in structlog.dev.ConsoleLogger is now configurable using the exception_formatter setting.
  If either the Rich or the 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,
  #​349

• The final processor can now return a bytearray (additionally to str and bytes).
  #​344

Changed

• 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 rendered without prettification.

• 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

Fixed

• structlog is now importable if sys.stdout is None (for example, when running using pythonw). #​313