You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/cse/rules/about-cse-rules.md
+42-1Lines changed: 42 additions & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -9,7 +9,7 @@ import useBaseUrl from '@docusaurus/useBaseUrl';
9
9
10
10
A Cloud SIEM rule is logic that fires based on information in incoming Records. When a rule fires, it creates a Signal.
11
11
12
-
[**Classic UI**](/docs/cse/introduction-to-cloud-siem/#classic-ui). To view Rules, in the top menu select **Content > Rules**.
12
+
[**Classic UI**](/docs/cse/introduction-to-cloud-siem/#classic-ui). To view Rules, in the top Cloud SIEM menu select **Content > Rules**.
13
13
14
14
[**New UI**](/docs/cse/introduction-to-cloud-siem/#new-ui). To view Rules, in the main Sumo Logic menu select **Cloud SIEM > Rules**. You can also click the **Go To...** menu at the top of the screen and select **Rules**.
15
15
@@ -43,6 +43,47 @@ There are several kinds of rules. Each supports a different sort of firing behav
43
43
***First Seen rule**. Fires when behavior by an Entity is encountered that hasn't been seen before. For example, the first time when a user logs in from a new location, or when a new admin account is created. For more information about First Seen rules, see [Write a First Seen Rule](/docs/cse/rules/write-first-seen-rule).
44
44
***Outlier rule**. Fires when behavior by an Entity is encountered that deviates from its baseline activity. For each Outlier rule, Cloud SIEM automatically creates a baseline model of normal behavior. After the baseline learning period is completed, activity that deviates from the mean (normal baseline behavior) creates a Signal. For more information about Outlier rules, see [Write an Outlier Rule](/docs/cse/rules/write-outlier-rule).
45
45
46
+
## Rule status
47
+
48
+
You can see a rule's status while viewing the rule:
49
+
* On the rule list page: <br/><img src={useBaseUrl('img/cse/rule-status-on-list-page.png')} alt="Rule status on list page" style={{border: '1px solid gray'}} width="800"/>
50
+
* On the rule details page: <br/><img src={useBaseUrl('img/cse/rule-status-on-detail-page.png')} alt="Rule status on details page" style={{border: '1px solid gray'}} width="800"/>
51
+
52
+
Following are the rule statuses:
53
+
54
+
| Status | Description | Action required |
55
+
| :-- | :-- | :-- |
56
+
| Active | The rule is executing normally. | No action required. |
57
+
| Degraded | The rule exceeded a [group limit](#group-limit) and was disabled. | No action required. The rule will be re-enabled and return to Active status once the rate period is reached. |
58
+
| Disabled | The rule was manually disabled using the toggle in the UI, or was disabled [with the API](https://api.sumologic.com/docs/sec/#operation/UpdateRuleEnabled). | Enable the rule with the toggle in the UI, or use the API. |
59
+
| Failed | The rule exceeded [signal limit](#signal-limit) and was disabled. | Edit the rule so that it will not exceed the rule limit again. Then enable the rule with the toggle in the UI, or with the API. |
60
+
61
+
<!-- I did not see any Warning status rules in the sandbox.
62
+
| Warning | The rule exceeded a [group limit](#group-limit). | Edit the rule so you will not lose baseline data. The rule will continue to run for up to 7 more days after the warning first appears. |
63
+
-->
64
+
65
+
## Rule limits
66
+
67
+
Limits are set on the number of signals that a rule is allowed to fire so that the system is not overloaded.
68
+
69
+
### Signal limit
70
+
71
+
If a rule fires more than 100 K signals in 1 hour or 1 M signals in 24 hours, the [rule status](#rule-status) changes from Active to Failed, and the rule is disabled.
72
+
73
+
| Type of limit | Limit | Result of exceeding the limit |
74
+
| :-- | :-- | :-- |
75
+
| Signals per hour | 100 K | Rule is disabled. Status changes from Active to Failed. |
76
+
| Signals per 24 hours | 1 M | Rule is disabled. Status changes from Active to Failed. |
77
+
78
+
### Group limit
79
+
80
+
All rules except Match rules group the record stream before attempting to trigger a signal. If a rule groups too many items beyond the limit, the [rule status](#rule-status) changes to Degraded.
81
+
82
+
| Type of limit | Limit | Result of exceeding the limit |
83
+
| :-- | :-- | :-- |
84
+
| Matched records per day | 20 K records per day | Status changes to Degraded until the end of the day when it becomes Active again. |
85
+
| Distinct seen occurrences per entity <br/>([First Seen](/docs/cse/rules/write-first-seen-rule/) rule only) | 10 K distinct occurrences | Status changes to Degraded until the system automatically removes the oldest seen occurrences to bring the count under the limit. Then it becomes Active again. |
86
+
46
87
## About rule expressions
47
88
48
89
The key element of a Cloud SIEM rule is a *rule expression*. A rule expression defines what conditions the rule will look for. A rule expression includes one or more equality statements, each of which evaluates a field value in incoming Records, typically comparing it to a constant value, for example `description = 'CMS Domain Match'`. A simple rule expression might be a single equality expression, or multiple expressions combined with logical operators. A rule expression evaluates to a boolean value. When a rule’s conditions are met, it creates a Signal.
0 commit comments