Skip to content

Commit

Permalink
README: mention the lack of filter_parameters sub-keys support
Browse files Browse the repository at this point in the history
Fixes airbrake/airbrake-ruby#137
(Support deep keys)
  • Loading branch information
kyrylo committed Dec 15, 2016
1 parent 0b24f53 commit ff4bf9b
Showing 1 changed file with 11 additions and 0 deletions.
11 changes: 11 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -169,6 +169,15 @@ Consult the
[example application](https://github.com/kyrylo/airbrake-ruby-issue108), which
was created to show how to configure `filter_parameters`.


##### filter_parameters dot notation warning

The dot notation introduced in [rails/pull/13897][rails-13897] for
`filter_parameters` (e.g. a key like `credit_card.code`) is unsupported for
performance reasons. Instead, simply specify `code` to ignore. If you have a
strong opinion on this, leave a comment in
the [dedicated issue][rails-sub-keys].

### Sinatra

To use Airbrake with Sinatra, simply `require` the gem, [configure][config] it
Expand Down Expand Up @@ -518,3 +527,5 @@ commands to invoke them.
[heroku-docs]: https://devcenter.heroku.com/articles/airbrake
[dashboard]: https://s3.amazonaws.com/airbrake-github-assets/airbrake/airbrake-dashboard.png
[arthur-ruby]: https://s3.amazonaws.com/airbrake-github-assets/airbrake/arthur-ruby.jpg
[rails-13897]: https://github.com/rails/rails/pull/13897
[rails-sub-keys]: https://github.com/airbrake/airbrake-ruby/issues/137

0 comments on commit ff4bf9b

Please sign in to comment.