Log Redactor

https://github.com/xtream1101/logredactor

Admin

Redacts sensitive data in Python logs based on regex filters, supporting JSON logging formats and...

Tokens:617

Snippets:5

Trust Score:7.7

License:MIT

Update:4 months ago

Show doc for...

Tokens:

Raw

### Apply Redaction Filter Globally to All Loggers

Source: https://github.com/xtream1101/logredactor/blob/master/README.md

This example demonstrates how to apply the RedactingFilter to all loggers by overriding the root logger's handlers. It includes an example of redacting an API key from a URL within nested JSON log data.

```python
import re
import logging
import logredactor
from pythonjsonlogger import jsonlogger

# Create a pattern to hide api key in url. This uses a _Positive Lookbehind_
redact_patterns = [re.compile(r'(?<=api_key=)[\w-]+')]

# Override the logging handler that you want redacted
class RedactStreamHandler(logging.StreamHandler):
    def __init__(self, *args, **kwargs):
        logging.StreamHandler.__init__(self, *args, **kwargs)
        self.addFilter(logredactor.RedactingFilter(redact_patterns))

root_logger = logging.getLogger()

sys_stream = RedactStreamHandler()
# Also set the formatter to use json, this is optional and all nested keys will get redacted too
sys_stream.setFormatter(jsonlogger.JsonFormatter('%(name)s %(message)s'))
root_logger.addHandler(sys_stream)

logger = logging.getLogger(__name__)

logger.error("Request Failed", extra={'url': 'https://example.com?api_key=my-secret-key'})
# Output: {"name": "__main__", "message": "Request Failed", "url": "https://example.com?api_key=****"}
```

--------------------------------

### Add Redaction Filter to a Specific Logger

Source: https://github.com/xtream1101/logredactor/blob/master/README.md

This snippet shows how to add a RedactingFilter to a specific logger instance. You can define custom regex patterns and a default mask. If no default mask is provided, four asterisks will be used.

```python
import re
import logging
import logredactor

# Create a logger
logger = logging.getLogger()
# Add the redact filter to the logger with your custom filters
redact_patterns = [re.compile(r'\d+')]

# if no `default_mask` is passed in, 4 asterisks will be used
logger.addFilter(logredactor.RedactingFilter(redact_patterns, default_mask='xx'))

logger.warning("This is a test 123...")
# Output: This is a test xx...
```

Tokens:

Raw