-
Notifications
You must be signed in to change notification settings - Fork 237
Data Masking (Beta) #6577
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
JV0812
wants to merge
8
commits into
main
Choose a base branch
from
data-masking-beta
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Data Masking (Beta) #6577
Changes from 3 commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
3faeb86
Data Masking (Beta)
JV0812 5f3de1f
Merge branch 'main' into data-masking-beta
JV0812 2128542
Apply suggestion from @JV0812
JV0812 f1e8907
Update docs/manage/data-masking.md
JV0812 a3bbf01
Update docs/manage/data-masking.md
JV0812 8ccbb42
Merge branch 'main' into data-masking-beta
JV0812 49c7545
added more content
JV0812 61314f6
Merge branch 'data-masking-beta' of https://github.com/SumoLogic/sumo…
JV0812 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,94 @@ | ||
| --- | ||
| id: data-masking | ||
| title: How to manage data masking rules in Sumo Logic | ||
| keywords: | ||
| - data-masking | ||
| - data-protection | ||
| - regex-locator | ||
| description: Learn how to create, edit, disable, and delete data masking rules to protect sensitive data across your organization. | ||
| --- | ||
|
|
||
| <head> | ||
| <meta name="robots" content="noindex" /> | ||
| </head> | ||
|
|
||
| <p><a href={useBaseUrl('docs/beta')}><span className="beta">Beta</span></a></p> | ||
|
|
||
| import useBaseUrl from '@docusaurus/useBaseUrl'; | ||
|
|
||
| Data Masking provides a centralized place to manage and review data masking rules across your organizational hierarchy, helping you enforce data protection standards and prevent sensitive information from appearing in your logs. | ||
JV0812 marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| ## How to create a data masking rule? | ||
|
|
||
| You can create an data masking rule of your own from scratch by following the instructions below: | ||
|
|
||
| :::note | ||
| - You need the `Manage Data Masking Rules` [role capability](/docs/manage/users-roles/roles/role-capabilities/) to create, edit, or disable a data hiding rule. Whereas, `View Unmasked Data` [role capability](/docs/manage/users-roles/roles/role-capabilities/) helps you to just view the masked data. | ||
| - An organization can have a maximum of **50 data masking rules**. | ||
| ::: | ||
|
|
||
| 1. [**New UI**](/docs/get-started/sumo-logic-ui). To access the Data Masking page, in the main Sumo Logic menu select **Data Management**, and then under **Logs** select **Data Masking**. You can also click the **Go To...** menu at the top of the screen and select **Data Masking**. <br/>[**Classic UI**](/docs/get-started/sumo-logic-ui-classic). In the main Sumo Logic menu, select **Manage Data > Logs > Data Masking**. | ||
| 1. Click the **+ Add Data Masking Rule** button on the top right of the table.<br/><img src={useBaseUrl('img/manage/data-masking-rule/data-masking.png')} alt="Data Masking" style={{border: '1px solid gray'}} width="800"/> | ||
| 1. On the **Create New Data Masking Rule** page, fill in the following fields:<br/><img src={useBaseUrl('img/manage/data-masking-rule/create-data-masking-rule.png')} alt="Create data masking rule" style={{border: '1px solid gray'}} width="400"/> | ||
| 1. **Name**. A unique, descriptive name for the rule. This cannot be changed after creation. | ||
| 1. (Optional)**Description**. An optional summary of what the rule masks and why. | ||
JV0812 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| 1. **Regex Locator**. A regular expression pattern used to identify the segment of log data to mask. Sumo Logic evaluates this pattern against incoming log messages and applies masking to every match. Ensure your regex targets only the sensitive portion to avoid unintended masking. | ||
| 1. (Optional)**Mask String**. The replacement text that substitutes any content matched by the Regex Locator. If left blank, Sumo Logic replaces matched content with a default mask. | ||
JV0812 marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| 1. Click **Save** to activate the rule. | ||
|
|
||
| ## How to edit a data masking rule? | ||
|
|
||
| Follow the below steps to edit the data masking rule: | ||
|
|
||
| 1. [**New UI**](/docs/get-started/sumo-logic-ui). To access the Data Masking page, in the main Sumo Logic menu select **Data Management**, and then under **Logs** select **Data Masking**. You can also click the **Go To...** menu at the top of the screen and select **Data Masking**. <br/>[**Classic UI**](/docs/get-started/sumo-logic-ui-classic). In the main Sumo Logic menu, select **Manage Data > Logs > Data Masking**. | ||
| 1. Click the rule that you want to edit. Or, click the kebab icon against the selected rule and select **Edit** from the dropdown.<br/><img src={useBaseUrl('img/manage/data-masking-rule/edit-data-masking-rule.png')} alt="Edit data masking rule" style={{border: '1px solid gray'}} width="800"/> | ||
| 1. In the right-pane panel, click **Edit**.<br/><img src={useBaseUrl('img/manage/data-masking-rule/edit-data-masking-rule-2.png')} alt="Edit data masking rule" style={{border: '1px solid gray'}} width="400"/> | ||
| 1. Edit the fields as per your requirement. | ||
| :::note | ||
| The **Name** field cannot be edited after a rule is created. | ||
| ::: | ||
| 1. Click **Save** to update the rule. | ||
|
|
||
| ## How to disable a data masking rule? | ||
|
|
||
| Follow the below steps to disable the data masking rule: | ||
|
|
||
| 1. [**New UI**](/docs/get-started/sumo-logic-ui). To access the Data Masking page, in the main Sumo Logic menu select **Data Management**, and then under **Logs** select **Data Masking**. You can also click the **Go To...** menu at the top of the screen and select **Data Masking**. <br/>[**Classic UI**](/docs/get-started/sumo-logic-ui-classic). In the main Sumo Logic menu, select **Manage Data > Logs > Data Masking**. | ||
| 1. Click the rule that you want to disable. Or, click the kebab icon against the selected rule and select **Disable** from the dropdown.<br/><img src={useBaseUrl('img/manage/data-masking-rule/disable-data-masking-rule.png')} alt="Disable data masking rule" style={{border: '1px solid gray'}} width="800"/> | ||
| 1. In the right-pane panel, click **More Actions** and select **Disable** from the dropdown.<br/><img src={useBaseUrl('img/manage/data-masking-rule/disable-data-masking-rule-2.png')} alt="Disable data masking rule" style={{border: '1px solid gray'}} width="400"/> | ||
| 1. Click **Disable** in the confirmation dialog to confirm.<br/><img src={useBaseUrl('img/manage/data-masking-rule/disable-rule-confirmation-dialog.png')} alt="Disable Rule Confirmation Dialog" style={{border: '1px solid gray'}} width="400"/> | ||
|
|
||
| ## How to delete a data masking rule? | ||
|
|
||
| Follow the below steps to delete the data masking rule: | ||
|
|
||
| 1. [**New UI**](/docs/get-started/sumo-logic-ui). To access the Data Masking page, in the main Sumo Logic menu select **Data Management**, and then under **Logs** select **Data Masking**. You can also click the **Go To...** menu at the top of the screen and select **Data Masking**. <br/>[**Classic UI**](/docs/get-started/sumo-logic-ui-classic). In the main Sumo Logic menu, select **Manage Data > Logs > Data Masking**. | ||
| 1. Click the rule that you want to delete. Or, click the kebab icon against the selected rule and select **Delete** from the dropdown.<br/><img src={useBaseUrl('img/manage/data-masking-rule/delete-data-masking-rule.png')} alt="Delete data masking rule" style={{border: '1px solid gray'}} width="800"/> | ||
| 1. In the right-pane panel, click **More Actions** and select **Delete** from the dropdown.<br/><img src={useBaseUrl('img/manage/data-masking-rule/delete-data-masking-rule-2.png')} alt="Delete data masking rule" style={{border: '1px solid gray'}} width="400"/> | ||
| 1. Click **Delete** in the confirmation dialog to confirm.<br/><img src={useBaseUrl('img/manage/data-masking-rule/delete-rule-confirmation-dialog.png')} alt="Delete Rule Confirmation Dialog" style={{border: '1px solid gray'}} width="400"/> | ||
|
|
||
| ## FAQs | ||
|
|
||
| ### What is Data Masking in Sumo Logic? | ||
|
|
||
| Data Masking is a centralized feature that lets you create and manage rules to automatically redact or replace sensitive data in your logs. It helps enforce data protection standards consistently across your organizational hierarchy. | ||
|
|
||
| ### What role capability is needed to manage data masking rules? | ||
|
|
||
| You need the `Manage Data Masking Rules` role capability to create, edit, or disable rules. Users with the `View Unmasked Data` capability can view log data in its original, unmasked form. | ||
|
|
||
| ### What should be entered as the Mask String? | ||
|
|
||
| The **Mask String** is the text that replaces any content matched by your Regex Locator. It can be any string, such as `[MASKED]`, `****`, or `[REDACTED]`. If you leave it blank, Sumo Logic applies a default mask. Choose a value that clearly signals to viewers that data has been intentionally hidden. | ||
|
|
||
| ### Can the rule name be edited after it's been created? | ||
|
|
||
| No. The **Name** field is locked after creation. If you need to rename a rule, you must delete the existing rule and create a new one with the desired name. | ||
|
|
||
| ### What is the difference between disabling and deleting a rule? | ||
|
|
||
| Disabling a rule pauses masking while preserving the rule's configuration so it can be re-enabled later. Deleting a rule permanently removes it and cannot be undone. | ||
|
|
||
| ### Is there a limit to how many data masking rules an organization can create? | ||
|
|
||
| Yes. An organization can have a maximum of **50 data masking rules**. To add a new rule once the limit is reached, an existing rule must be deleted first. | ||
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+63.7 KB
static/img/manage/data-masking-rule/delete-rule-confirmation-dialog.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added
BIN
+56.1 KB
static/img/manage/data-masking-rule/disable-rule-confirmation-dialog.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
You need to change "Beta" to the appropriate preview type. The types are still in flux. @kimsauce is working on it with https://sumologic.atlassian.net/browse/DOCS-1541.