-
Notifications
You must be signed in to change notification settings - Fork 1.2k
[DOCS-8106] Add Cloud SIEM data security doc #30536
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
maycmlee
wants to merge
12
commits into
master
Choose a base branch
from
may/cloud-siem-data-security
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.
Open
Changes from all commits
Commits
Show all changes
12 commits
Select commit
Hold shift + click to select a range
6cd9595
add data security doc
maycmlee 143ddea
Merge branch 'master' into may/cloud-siem-data-security
maycmlee 5111b48
add hipaa note
maycmlee 2ecb0e7
edit warning
maycmlee 4dfb642
updates
maycmlee c2a206b
small update
maycmlee 08573c0
merge master
maycmlee a22a645
add links to doc
maycmlee a0ce3ed
Apply suggestions from code review
maycmlee 5890046
Update content/en/security/cloud_siem/detection_rules/signal_correlat…
maycmlee 8c063d5
fix nav
maycmlee 75dc86f
Merge branch 'master' into may/cloud-siem-data-security
maycmlee 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,62 @@ | ||
--- | ||
title: Cloud SIEM Data Security | ||
disable_toc: false | ||
further_reading: | ||
- link: "/data_security/" | ||
tag: "Documentation" | ||
text: "Review the main categories of data submitted to Datadog" | ||
- link: "/data_security/pci_compliance/" | ||
tag: "Documentation" | ||
text: "Set up a PCI-compliant Datadog organization" | ||
--- | ||
|
||
<div class="alert alert-info">This page is about the security of data sent to Datadog. If you're looking for cloud and application security products and features, see the <a href="/security/" target="_blank">Security</a> section.</div> | ||
|
||
## Overview | ||
|
||
Datadog generates a security signal when at least one case defined in a detection rule is matched over a given period of time. You can customize detection rules to provide notification messages that contain specific information about the signal (for example, user ID, IP addresses, and so on) and the triggering group-by values of the signal. Security rules can also use webhooks to send notifications to third-party services. | ||
|
||
Because data sent to Datadog may contain sensitive information, this document goes over those notification features and what to do if you do not want your users to have access to these features. | ||
|
||
## Security rules can use message template variables | ||
|
||
When you create a detection rule you can customize the notification message with [notification variables][1], which adds specific information related to the signal. For example, if the following JSON object is associated with a security signal: | ||
|
||
``` | ||
{ | ||
"network": { | ||
"client": { | ||
"ip": "1.2.3.4" | ||
} | ||
}, | ||
"user": { | ||
"id": "[email protected]" | ||
}, | ||
"used_mfa": "false" | ||
} | ||
``` | ||
Using `{{@network.client.ip}}` in the notification message would display the IP address associated with the signal. | ||
|
||
Contact [support][2] if you want to prevent users from adding template variables to notification messages. | ||
|
||
## Security rules can include triggering group-by values in the notification title | ||
|
||
In the **Describe your playbook** sections for [log detection rules][3] and [signal correlation rules][4], you can add group-by values in the notification title. For example, if you are grouping by `service`, the service name shows in the title. Uncheck **Include triggering group-by values in notification title** to prevent group-by values from appearing in the title. | ||
|
||
Contact [support][2] if you want to remove the **Include triggering group-by values in notification title** option. | ||
|
||
## Security rules can use webhooks | ||
|
||
<div class="alert alert-warning">If your organization had HIPAA enabled in 2024 or earlier, reach out to <a href = "https://docs.datadoghq.com/help/">Datadog support</a> to enable webhooks for security rules.</a></div> | ||
|
||
Security notifications can be sent to [integrations][5], such as Jira, PagerDuty, and [webhooks][6]. Contact [support][2] to prevent users from sending notifications to third-party services using webhooks. | ||
|
||
## Further reading | ||
{{< partial name="whats-next/whats-next.html" >}} | ||
|
||
maycmlee marked this conversation as resolved.
Show resolved
Hide resolved
|
||
[1]: /security/notifications/variables/?tab=cloudsiem#template-variables | ||
[2]: /help/ | ||
[3]: /security/cloud_siem/log_detection_rules/?tab=threshold#describe-your-playbook | ||
[4]: /security/cloud_siem/signal_correlation_rules#describe-your-playbook | ||
[5]: /security/notifications/#integrations | ||
[6]: /integrations/webhooks/ |
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
Oops, something went wrong.
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.
Looks like Guides also has a weight of 9, which is keeping it from appearing at the end?
I might also consider putting the topics that are specific to Data Security at the top rather than at the bottom - it might make it a little easier to understand basic principles before going off to portions of the docs where the info is less centred around it. But I'll leave that up to you, because you're more familiar with how users engage with the docs than I am 🙂
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.
Thanks for catching that! I put the guides at the bottom.