Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
armurox committed Nov 14, 2024
1 parent 66809dd commit 4ee707f
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -128,15 +128,16 @@ logging.config.dictConfig(LOGGING)
The essence boils down to adding the RedactingFilter to your logging config, and to the filters section of the associated handlers to which you want to apply the redaction.


## Release Notes - v0.0.2:
## Release Notes - v0.0.3:

### Improvements and Changes
- Optimized function that applies the redaction (was setting the logger message value twice).
- Changed default_mask key initialization to mask
- Changed patterns key initialization to mask_patterns

### Bug Fixes
- Handled any exceptions related to deepcopies failing, related to attempt to redact IOStreams
- Handled any exceptions related to deepcopies failing, related to attempt to redact IOStreams, including TypeError


## A Note about the Motivation behind Logging Redactor:
Logging Redactor started as a fork of [logredactor](https://pypi.org/project/logredactor/). However, due to the bugs present in the original (specifically the data mutations), it was not usable in production environments where the purpose was to only redact variables in the logs, not in their usage in the code. This, along with the fact that the original package is no longer maintained lead to the creation of Logging Redactor.

0 comments on commit 4ee707f

Please sign in to comment.