README.md in logstop-0.1.0 vs README.md in logstop-0.2.0

- old
+ new

@@ -11,17 +11,20 @@ - email addresses - phone numbers - credit card numbers - Social Security numbers (SSNs) +- passwords in urls Works with all types of logging - Ruby, ActiveRecord, ActiveJob, and more ``` -User Load (0.1ms) SELECT "users".* FROM "users" WHERE "users"."email" = ? [["email", "[FILTERED]"]] +User Load (0.1ms) SELECT "users".* FROM "users" WHERE "users"."email" = ? [["email", "[FILTERED]"]] ``` +[![Build Status](https://travis-ci.org/ankane/logstop.svg?branch=master)](https://travis-ci.org/ankane/logstop) + ## Installation Add this line to your application’s Gemfile: ```ruby @@ -40,12 +43,20 @@ ```ruby Logstop::Formatter.new(formatter, ip: true) ``` +To scrub outside of logging, use: + +```ruby +Logstop.scrub(msg) +``` + ## Note This should be used in addition to `config.filtered_parameters`, not as a replacement. + +To scrub existing log files, check out [scrubadub](https://github.com/datascopeanalytics/scrubadub). ## Resources - [List of PII, as defined by NIST](https://en.wikipedia.org/wiki/Personally_identifiable_information#NIST_definition)