Skip to content

Commit e94a5e1

Browse files
authored
Add example (#5300)
1 parent 34913fe commit e94a5e1

File tree

6 files changed

+23
-3
lines changed

6 files changed

+23
-3
lines changed

docs/alerts/scheduled-searches/generate-cse-signals.md

Lines changed: 23 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,8 @@ For a more detailed description of the options you can configure for a scheduled
1515

1616
## Requirements for the search query
1717

18+
When you [create a scheduled search](/docs/alerts/scheduled-searches/schedule-search/) to generate signals in Cloud SIEM, you start by creating a search query.
19+
1820
This section describes the requirements for your scheduled search, which include a minimum set of fields to be returned, and renaming message fields as necessary to match attribute names in the selected Cloud SIEM record type schema.  
1921

2022
### Required fields
@@ -42,7 +44,6 @@ enable signal generation:
4244
If the `stage` field contains a Tactic that isn't in the MITRE ATT&CK framework, a signal will not be generated, but a record will be. 
4345
:::
4446
* At least one entity field:
45-
4647
* `device_ip`
4748
* `device_mac`
4849
* `device_natIp`
@@ -56,16 +57,35 @@ enable signal generation:
5657
* `srcDevice_ip`
5758
* `srcDevice_mac`
5859
* `srcDevice_natIp`
59-
* `user_username`  
60+
* `user_username`
6061

6162
### Renaming message fields
6263

6364
When you configure a Scheduled Search to create Cloud SIEM signals, you are prompted to select a [Cloud SIEM record type](/docs/cse/schema/cse-record-types/). The fields returned by your search must match an attribute in the record type you select. A field whose name does not match a Cloud SIEM attribute will not be populated in the record created from the Schedule Search results. For more about Cloud SIEM attribute names, see [Attributes You Can Map to Records](/docs/cse/schema/attributes-map-to-records/).
6465

66+
### Example
67+
68+
Let's suppose that `user_username` is the entity field we want to use, and its value needs to be mapped to `actor.email`. Then you need to add the following line to the query: `actor.email as user_username`.
69+
70+
And because the final output of this query is an aggregate, and Cloud SIEM signals expect `normalizedfield`, `stage`, and `entity`, we need need to add those in the `count` expression.
71+
72+
This is how the final query might look:
73+
74+
```txt
75+
((_index=sec_record_* objectType=*)
76+
AND _sourcename = "Google Apps Audit Event")
77+
AND _sourcecategory = "GoogleWorkspace/Groups"
78+
| 5 as normalizedseverity
79+
| "Initial Access" as stage
80+
| json auto
81+
| actor.email as user_username
82+
| count by events.name, events.type, actor.email, event.parameters.user_email, event.parameters.group_email, user_username, stage, normalizedseverity
83+
```
84+
6585
## Scheduling the search
6686

6787
1. After creating and saving your search, click the save icon.<br/><img src={useBaseUrl('img/alerts/save-as.png')} alt="Save the search" style={{border: '1px solid gray'}} width="800"/>
68-
1. The **Save Item** popup appears.<br/><img src={useBaseUrl('img/alerts/save-item.png')} alt="Save as scheduled search" width="500"/>
88+
1. The **Save Item** popup appears.<br/><img src={useBaseUrl('img/alerts/save-item.png')} alt="Save as scheduled search" style={{border: '1px solid gray'}} width="500"/>
6989
:::note
7090
The name of your scheduled search will appear as the signal name in Cloud SIEM.
7191
:::
49.8 KB
Loading

static/img/alerts/options.png

62.7 KB
Loading
18.5 KB
Loading

static/img/alerts/save-as.png

88.2 KB
Loading

static/img/alerts/save-item.png

80.1 KB
Loading

0 commit comments

Comments
 (0)