ankane / logstop.py

Keep personal data out of your logs

Logstop.py

🔥 Keep personal data out of your logs

logger.info('Hi [e-mail]!')
# Hi **********!

By default, scrubs:

• email addresses
• phone numbers
• credit card numbers
• Social Security numbers (SSNs)
• passwords in URLs

Works even when data is URL-encoded with plus encoding

Installation

Run:

pip install logstop

And add it to your logger:

from logstop import LogstopFilter

logger.addFilter(LogstopFilter())

Options

To scrub IP addresses (IPv4), use:

LogstopFilter(ip=True)

To scrub MAC addresses, use:

LogstopFilter(mac=True)

Disable default rules with:

LogstopFilter(
    email=False,
    phone=False,
    credit_card=False,
    ssn=False,
    url_password=False
)

Notes

• To scrub existing log files, check out scrubadub
• To scan for unencrypted personal data in your database, check out pdscan

History

View the changelog

Contributing

Everyone is encouraged to help improve this project. Here are a few ways you can help:

• Report bugs
• Fix bugs and submit pull requests
• Write, clarify, or fix documentation
• Suggest or add new features

To get started with development:

git clone https://github.com/ankane/logstop.py.git
cd logstop.py
pip install -r requirements.txt
pytest