Sha256: 0d1842f5d444f766cc7f83c89835ac22163503d9a7058e250076df96c6c8ff01

Contents?: true

Size: 1.19 KB

Versions: 26

Compression:

Stored size: 1.19 KB

Contents

## Filtering out sensitive data

**NOTE: This is intended for (and will currently only work with) Rack-like applications, which include a `params` key in their `payload` hash**

You may not want to log certain parameters which have sensitive information to be in the logs, e.g. `password`.  This can be set using the `filter_parameters` option when using `configure`:

```ruby
Sapience.configure do |config|
  # Filter the value of "foo" from rack's parameter hash
  config.filter_parameters << 'foo'
end
```

Note that by default this is set to `['password', 'password_confirmation']`, so be careful when explicitly setting, as you may lose this filtering:

```ruby
Sapience.configure do |config|
  # NOTE: password and password_confirmation will no longer be filtered
  config.filter_parameters = ['foo']
end
```

Similarly, *be particularly careful* when setting as `yaml` because this will no longer filter `password` and `password_confirmation`:

```yaml
some_environment:
  # NOTE: password and password_confirmation will no longer be filtered if they're not included in this list
  filter_parameters:
    - foo
```

Any filtered parameter will still show in the `params` field, but it's value will be `[FILTERED]`.

Version data entries

26 entries across 26 versions & 1 rubygems

Version Path
sapience-3.0 docs/filter_parameters.md
sapience-2.15 docs/filter_parameters.md
sapience-2.14 docs/filter_parameters.md
sapience-2.13 docs/filter_parameters.md
sapience-2.12 docs/filter_parameters.md
sapience-2.11 docs/filter_parameters.md
sapience-2.10 docs/filter_parameters.md
sapience-2.9.1 docs/filter_parameters.md
sapience-2.8 docs/filter_parameters.md
sapience-2.7.0 docs/filter_parameters.md
sapience-2.6.1 docs/filter_parameters.md
sapience-2.6.0 docs/filter_parameters.md
sapience-2.5.4 docs/filter_parameters.md
sapience-2.5.3 docs/filter_parameters.md
sapience-2.5.2 docs/filter_parameters.md
sapience-2.5.0 docs/filter_parameters.md
sapience-2.4.0 docs/filter_parameters.md
sapience-2.3.5 docs/filter_parameters.md
sapience-2.3.4 docs/filter_parameters.md
sapience-2.3.3 docs/filter_parameters.md