README.md in logstop-0.2.3 vs README.md in logstop-0.2.4
- old
+ new
@@ -1,28 +1,30 @@
# Logstop
:fire: Keep personally identifiable information (PII) out of your logs
```ruby
-logger.info "Hi test@test.com!"
+logger.info "Hi test@example.org!"
# => Hi [FILTERED]!
```
By default, scrubs:
- email addresses
- phone numbers
- credit card numbers
- Social Security numbers (SSNs)
-- passwords in urls
+- 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]"]]
```
+Works even when sensitive data is URL-encoded
+
[![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:
@@ -51,24 +53,38 @@
```ruby
Logstop.guard(logger, ip: true)
```
+Add custom rules with: [master]
+
+```ruby
+scrubber = lambda do |msg|
+ msg.gsub(/custom_regexp/, "[FILTERED]".freeze)
+end
+
+Logstop.guard(logger, scrubber: scrubber)
+```
+
To scrub outside of logging, use:
```ruby
Logstop.scrub(msg)
```
-## Note
+It supports the same options as `guard`.
+## Notes
+
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).
To anonymize IP addresses, check out [IP Anonymizer](https://github.com/ankane/ip_anonymizer).
+Learn more about [securing sensitive data in Rails](https://ankane.org/sensitive-data-rails).
+
## Resources
- [List of PII, as defined by NIST](https://en.wikipedia.org/wiki/Personally_identifiable_information#NIST_definition)
## History
@@ -81,5 +97,14 @@
- [Report bugs](https://github.com/ankane/logstop/issues)
- Fix bugs and [submit pull requests](https://github.com/ankane/logstop/pulls)
- Write, clarify, or fix documentation
- Suggest or add new features
+
+To get started with development and testing:
+
+```sh
+git clone https://github.com/ankane/logstop.git
+cd logstop
+bundle install
+rake test
+```