Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add note to structlog docs #116

Merged
merged 1 commit into from
Feb 17, 2024
Merged

Add note to structlog docs #116

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
6 changes: 6 additions & 0 deletions docs/integrations/structlog.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,12 @@ but before the final processor, as it is responsible for emitting the log event
more information, see the
`structlog documentation <https://www.structlog.org/en/stable/processors.html#adapting-and-rendering>`_.

.. note::

:class:`logot.structlog.StructlogCapturer` works by changing the :mod:`structlog` configuration. If you have
`cache_logger_on_first_use` enabled in your :func:`structlog.configure` or :func:`structlog.wrap_logger` call for
performance reasons, you will need to disable it during tests to enable log capturing.


Installing
----------
Expand Down