Skip to content
This repository has been archived by the owner on Apr 20, 2024. It is now read-only.

Commit

Permalink
Add README for keyFilters feature
Browse files Browse the repository at this point in the history
  • Loading branch information
cweinberger committed Feb 26, 2020
1 parent d181326 commit d2b5c47
Showing 1 changed file with 14 additions and 0 deletions.
14 changes: 14 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -115,6 +115,20 @@ enum BreadcrumbType {
}
```

#### Filter out fields from reports
Usually you will receive information such as headers, query params or post body fields in the reports from Bugsnag. To ensure that you do not track sensitive information, you can configure Bugsnag with a list of fields that should be filtered out:

```swift
BugsnagConfig(
apiKey: "apiKey",
releaseStage: "test",
keyFilters: ["password", "email", "authorization", "lastname"]
)
```
In this case Bugsnag Reports won't contain header fields, query params or post body json fields with the keys/names **password**, **email**, **authorization**, **lastname**.

⚠️ Note: in JSON bodies, this only works for the first level of fields and not for nested children.

## 🏆 Credits

This package is developed and maintained by the Vapor team at [Nodes](https://www.nodesagency.com).
Expand Down

0 comments on commit d2b5c47

Please sign in to comment.