Skip to content

Commit c649c0b

Browse files
authored
doc(pii): Advanced data scrubbing stabilized (#1786)
This is the absolute minimum amount of changes we need to get out on June 30th. GA toggle PR is here: getsentry/sentry#19630
1 parent 32f27f8 commit c649c0b

File tree

1 file changed

+7
-17
lines changed

1 file changed

+7
-17
lines changed

src/collections/_documentation/data-management/advanced-datascrubbing.md

Lines changed: 7 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,15 @@
11
---
2-
title: 'Advanced Data Scrubbing (Beta)'
2+
title: 'Advanced Data Scrubbing'
33
sidebar_order: 4
44
keywords: ["pii", "gdpr", "personally identifiable data", "compliance"]
55
---
66

7-
In addition to using [`beforeSend`](/data-management/sensitive-data/#custom-event-processing-in-the-sdk) in your SDK or our [server-side data scrubbing features](/data-management/sensitive-data/#server-side-scrubbing) to redact sensitive data, we are currently beta-testing ways to give you more granular control over server-side data scrubbing of your events. Additional functionality includes:
7+
In addition to using [`beforeSend`](/data-management/sensitive-data/#custom-event-processing-in-the-sdk) in your SDK or our [regular server-side data scrubbing features](/data-management/sensitive-data/#server-side-scrubbing) to redact sensitive data, Advanced Data Scrubbing is an alternative way to redact sensitive information just before it is saved in Sentry. It allows you to:
88

99
* Define custom regular expressions to match on sensitive data
1010
* Detailed tuning on which parts of an event to scrub
1111
* Partial removal or hashing of sensitive data instead of deletion
1212

13-
## Overview
14-
15-
**Advanced Data Scrubbing is available only if your organization is enabled as an Early Adopter.** To enable this option, navigate to your organization's settings and enable the "Early Adopter" option. Turning on this option allows access to features prior to full release, and can be disabled at any time.
16-
17-
Early adopters have access to a new option in both organization settings as well as the setting of each project. Go to your project- or organization-settings and click _Security and Privacy_ in the sidebar. Scrolling down, you will find a new section _Advanced Data Scrubbing_.
18-
19-
Note that everything you configure there will have direct impact on all new events, just as all the other data privacy-related settings do. However, it is not possible to break or undo any other data scrubbing settings that you may have configured. In other words, it is only possible to accidentally remove too much data, not too little.
20-
21-
If you have any questions related to this feature, feel free to contact us at `[email protected]`.
22-
2313
## A Basic Example
2414

2515
Go to your project- or organization-settings and click _Security and Privacy_ in the sidebar. Scrolling down, you will find a new section _Advanced Data Scrubbing_.
@@ -29,7 +19,7 @@ Go to your project- or organization-settings and click _Security and Privacy_ in
2919
3. Select _Credit card numbers_ as _Data Type_.
3020
4. Enter `$string` as _Source_.
3121

32-
As soon as you hit _Save_, we will attempt to find all creditcard numbers in your events going forward, and replace them with a series of `******`, keeping only the last 4 digits.
22+
As soon as you hit _Save_, we will attempt to find all creditcard numbers in your events going forward, and replace them with a series of `******`.
3323

3424
Rules generally consist of three parts:
3525

@@ -39,10 +29,10 @@ Rules generally consist of three parts:
3929

4030
## Methods
4131

42-
- _Remove_: Remove the entire field. We may choose to either set it to `null`, remove it entirely or replace it with an empty string depending on technical constraints.
43-
- _Mask_: Replace all characters with `*`. For creditcards this replaces everything but the last 4 digits.
32+
- _Remove_: Remove the entire field. We may choose to either set it to `null`, remove it entirely, or replace it with an empty string depending on technical constraints.
33+
- _Mask_: Replace all characters with `*`.
4434
- _Hash_: Replace the matched substring with a hashed value.
45-
- _Replace_: Replace the matched substring with a constant placeholder value such as `[Filtered]` or `[creditcard]`. Right now this value cannot be configured.
35+
- _Replace_: Replace the matched substring with a constant _placeholder_ value (defaulting to `[Filtered]`).
4636

4737
## Data Types
4838

@@ -93,7 +83,7 @@ All key names are treated case-insensitively.
9383

9484
Above the _Source_ input field you will find another input field for an event ID. Providing a value there allows for better auto-completion of arbitrary _Additional Data_ fields and variable names.
9585

96-
The event ID is purely optional and the value is not saved as part of your settings. Data scrubbing settings always apply to all events within a project/organization going forward.
86+
The event ID is purely optional and the value is not saved as part of your settings. Data scrubbing settings always apply to all new events within a project/organization (going forward).
9787

9888
### Advanced source names
9989

0 commit comments

Comments
 (0)