Skip to content

Commit

Permalink
Add note about security considerations in the Readme (#957)
Browse files Browse the repository at this point in the history
Co-authored-by: Andrew Edwards <edwards.andrew@heb.com>
  • Loading branch information
aedwardstx and Andrew Edwards committed Aug 27, 2023
1 parent d17ae01 commit 3876de0
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -239,7 +239,8 @@ Logging exceptions that occur in your code is important to track bugs, but it's

The code::

logger.add("out.log", backtrace=True, diagnose=True) # Caution, may leak sensitive data in prod
# Caution, diagnose=True is the default and may leak sensitive data in prod
logger.add("out.log", backtrace=True, diagnose=True)

def func(a, b):
return a / b
Expand Down Expand Up @@ -277,6 +278,7 @@ Would result in:
Note that this feature won't work on default Python REPL due to unavailable frame data.

See `Security considerations when using Loguru <https://loguru.readthedocs.io/en/stable/resources/recipes.html#security-considerations-when-using-loguru>`_

Structured logging as needed
^^^^^^^^^^^^^^^^^^^^^^^^^^^^
Expand Down

0 comments on commit 3876de0

Please sign in to comment.