-
Notifications
You must be signed in to change notification settings - Fork 19
Add dedicated article for Limit data export rule #2136
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
Draft
claude
wants to merge
1
commit into
master
Choose a base branch
from
limit-data-export-rule
base: master
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.
Draft
Changes from all commits
Commits
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
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 @@ | ||
| --8<-- "latest/user-guides/rules/limit-data-export-rule.md" |
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
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 @@ | ||
| --8<-- "latest/user-guides/rules/limit-data-export-rule.md" |
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,48 @@ | ||
| [img-limit-data-export]: ../../images/user-guides/rules/limit-data-export-rule.png | ||
| [api-discovery-enable-link]: ../../api-discovery/setup.md | ||
|
|
||
| # Limiting Data Export | ||
|
|
||
| The **Limit data export** [rule](../rules/rules.md) controls whether Wallarm Nodes export full request and response data to the Wallarm Cloud. It allows configuring the export mode per endpoint - either full data or metadata only. This article describes how to use this rule. | ||
|
|
||
| ## Overview | ||
|
|
||
| In the [hybrid](../../about-wallarm/shared-responsibility.md#overview) Wallarm installations, when you manage the Wallarm Nodes in your infrastructure, and Wallarm manages the Wallarm Cloud component, you decide how much of your traffic data leaves your infrastructure. Wallarm provides full visibility of what data is sent from Node to Cloud and a [set of tools](../../admin-en/export-to-cloud.md) to shape this transfer to your needs - limiting data export is one of these tools. | ||
|
|
||
| A **Limit data export** rule applies to the traffic matching its [conditions](rules.md#configuring), so you can keep full export for most of your API and reduce it for the endpoints that carry the most sensitive data. | ||
|
|
||
| ## Export modes | ||
|
|
||
| The export mode is set by the **Full data export** value: | ||
|
|
||
| | **Full data export** | What the Node exports | | ||
| | ----- | ----- | | ||
| | **Enabled** | Full request and response data. | | ||
| | **Disabled** | Metadata only: the request method, URI, IP address, HTTP status code, request time, and the `Host` header. The body, query parameters, and other headers are excluded from both requests and responses. | | ||
| | **Keep headers** | Metadata and headers. | | ||
|
|
||
| !!! warning "" | ||
| If a request matches the rule conditions, the selected setting applies to both the request and the response data. | ||
|
|
||
| ## Side effects | ||
|
|
||
| Limiting export reduces the data available for analysis, so consider that it can affect: | ||
|
|
||
| * The details of [attacks](../../user-guides/events/check-attack.md) and [incidents](../../user-guides/events/check-incident.md) | ||
| * The [API Sessions](../../api-sessions/overview.md) data | ||
| * The [security issues](../../about-wallarm/detecting-vulnerabilities.md) data | ||
| * The accuracy of Threat Replay Testing | ||
|
|
||
| To exclude only specific parameters identified as containing sensitive data, such as passwords or tokens, use the [**Mask sensitive data**](sensitive-data-rule.md) rule instead - it cuts the values of the specified request points and keeps the rest of the data exported. | ||
|
|
||
| ## Creating and applying rule | ||
|
|
||
| To set the export mode: | ||
|
|
||
| --8<-- "../include/rule-creation-initial-step.md" | ||
| 1. Choose **Limit data export**. | ||
| 1. In **If request is**, [describe](rules.md#configuring) the scope to apply the rule to. | ||
| 1. In **Then**, set **Full data export** to the required [mode](#export-modes). | ||
| 1. Wait for the [rule compilation and uploading to the filtering node to complete](rules.md#ruleset-lifecycle). | ||
|
|
||
| ![Limit data export rule][img-limit-data-export] | ||
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
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
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
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.
also describe when a customer should use the "Limit data export" rule and when "Mask sensitive data" instead