https://github.com/mrexox/sentry-sanitizer
Sanitizing middleware for sentry-ruby gem
https://github.com/mrexox/sentry-sanitizer
ruby sanitizer sentry sentry-plugin sentry-ruby sentry-sanitizer
Last synced: 5 months ago
JSON representation
Sanitizing middleware for sentry-ruby gem
- Host: GitHub
- URL: https://github.com/mrexox/sentry-sanitizer
- Owner: mrexox
- License: bsd-3-clause
- Created: 2021-02-05T08:41:45.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2025-01-27T08:28:53.000Z (9 months ago)
- Last Synced: 2025-05-07T23:09:03.816Z (5 months ago)
- Topics: ruby, sanitizer, sentry, sentry-plugin, sentry-ruby, sentry-sanitizer
- Language: Ruby
- Homepage:
- Size: 144 KB
- Stars: 8
- Watchers: 2
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
Awesome Lists containing this project
README
[](https://badge.fury.io/rb/sentry-sanitizer)
[](https://coveralls.io/github/mrexox/sentry-sanitizer?branch=master)
# sentry-sanitizer: sanitizing extension for sentry-ruby
This gem aimed to add sanitizing support to [sentry-ruby](https://rubygems.org/gems/sentry-ruby) gem.
[sentry-raven](https://rubygems.org/gems/sentry-raven) gem had this apportunity but it is no longer supported. Moving from `sentry-raven` to `sentry-ruby` can surprise you with missing this ability. But you can still use `sentry-sanitizer` (with a little change to configuration).
Currently this gem provides following features
- [x] Sanitizing POST params
- [x] Sanitizing HTTP headers
- [x] Sanitizing cookies
- [x] Sanitizing query string
- [x] Sanitizing extras ([see](https://docs.sentry.io/platforms/ruby/enriching-events/context/#additional-data) `Sentry.set_extras`)
## Installation
:warning: Please, don't use `0.1.*` version as it was experimental and not usable at all.
Add this line to your application's Gemfile:
```ruby
gem 'sentry-sanitizer', '>= 0.2.0'
```
And then execute:
$ bundle
Or install it yourself as:
$ gem install sentry-sanitizer
## Usage
Add following lines to your Sentry configuration:
```ruby
Sentry.init do |config|
# ... your configuration
# If using Rails
config.sanitize.fields = Rails.application.config.filter_parameters
# You can also pass custom array
config.sanitize.fields = %w[password super_secret_token]
# HTTP headers can be sanitized too (it is case insensitive)
config.sanitize.http_headers = %w[Authorization X-Xsrf-Token]
# You can sanitize all HTTP headers with setting `true` value
config.sanitize.http_headers = true
# You can sanitize all cookies with this setting
config.sanitize.cookies = true
# You can sanitize query string params for GET requests
config.sanitize.query_string = true
# ...
end
```
## Development
After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/mrexox/sentry-sanitizer.
## License
The gem is available as open source under the terms of the [BSD-3-Clause License](https://opensource.org/licenses/BSD-3-Clause).