Skip to content

Commit c4e5967

Browse files
[Security][Gap Fill][9.3 & Serverless]: Docs recent additions for gap fill feature (#4403)
<!-- Thank you for contributing to the Elastic Docs! 🎉 Use this template to help us efficiently review your contribution. --> ## Summary Contributes to #3969 by documenting the following UI changes that have been released in Serverless: - Updated panel about gaps info - New gap fill status filter - New gap fill status column in Rules table Note that within the "Rule Monitoring" section, content about rule gaps has been moved under a new sub-section titled "[Find rule execution gaps](https://docs-v3-preview.elastic.dev/elastic/docs-content/pull/4403/solutions/security/detect-and-alert/monitor-rule-executions#rule-monitoring-tab-gaps)" and the information has been slightly re-organized to show when certain functionality is available. ## Generative AI disclosure <!-- To help us ensure compliance with the Elastic open source and documentation guidelines, please answer the following: --> 1. Did you use a generative AI (GenAI) tool to assist in creating this contribution? - [ ] Yes - [x] No <!-- 2. If you answered "Yes" to the previous question, please specify the tool(s) and model(s) used (e.g., Google Gemini, OpenAI ChatGPT-4, etc.). Tool(s) and model(s) used: --> --------- Co-authored-by: Benjamin Ironside Goldstein <91905639+benironside@users.noreply.github.com>
1 parent 52119e5 commit c4e5967

File tree

2 files changed

+40
-20
lines changed

2 files changed

+40
-20
lines changed
-364 KB
Loading

solutions/security/detect-and-alert/monitor-rule-executions.md

Lines changed: 40 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -37,26 +37,50 @@ On the **Rule Monitoring** tab, you can [sort and filter rules](../detect-and-al
3737
To sort the rules list, click any column header. To sort in descending order, click the column header again.
3838
::::
3939

40-
4140
For detailed information on a rule, the alerts it generated, and associated errors, click on its name in the table. This also allows you to perform the same actions that are available on the [**Installed Rules** tab](manage-detection-rules.md), such as modifying or deleting rules, activating or deactivating rules, exporting or importing rules, and duplicating prebuilt rules.
4241

43-
For information about rule execution gaps (which are periods of time when a rule didn't run), use the panel above the table. The panel contains the following:
42+
### Find rule execution gaps [rule-monitoring-tab-gaps]
4443

45-
* **Time filter**: Allows you to select a time range for viewing gap data.
46-
* **Total rules with gaps:** Provides metrics for rules with gaps:
47-
48-
* {applies_to}`stack: ga 9.0` Tells you how many rules have unfilled or partially filled gaps within the selected time range.
49-
* {applies_to}`stack: ga 9.1` Tells you the number of rules with unfilled gaps (left metric) and the number of rules with gaps being filled (right metric).
50-
51-
* {applies_to}`stack: ga 9.0` **Only rules with gaps**: Filters the Rules table to only display rules with unfilled or partially filled gaps.
52-
* {applies_to}`stack: ga 9.1` **Only rules with unfilled gaps**: Filters the Rules table to only display rules with unfilled gaps. Note that the filter excludes rules with gaps that are being filled.
44+
The **Rule Monitoring** tab provides a starting point for understanding and remediating gaps in rule executions, which are periods of time where a rule didn’t run. Gaps can be caused by various disruptions, including system updates or simply turning off a rule. Addressing gaps is essential for maintaining consistent coverage and avoiding missed alerts.
5345

54-
Within the Rules table, the **Last Gap (if any)** column conveys how long the most recent gap for a rule lasted. The **Unfilled gaps duration** column shows whether a rule still has gaps and provides a total sum of the remaining unfilled or partially filled gaps. The total sum can change based on the time range that you select in the panel above the table. If a rule has no gaps, the columns display a dash (`––`).
46+
From the **Rule Monitoring** tab, you can get an overview of existing gaps and their status. The total number of rules with gaps is tracked in the panel above the Rules table. The information and functionality in the panel depends on the version of {{elastic-sec}} that you're using.
47+
48+
::::{applies-switch}
49+
50+
:::{applies-item} { "stack": "ga 9.3", "serverless": "ga" }
51+
The panel has the following:
52+
* **Rules with gaps:** Tells you the number of rules with gaps (left metric) and the number of rules with all gaps being filled (right metric). The metric shows data from the last 90 days.
53+
:::
54+
55+
:::{applies-item} { "stack": "ga 9.1" }
56+
The panel has the following:
57+
* **Time filter**: Allows you to select a time range for viewing gap data.
58+
* **Total rules with gaps:** Tells you the number of rules with unfilled gaps (left metric) and the number of rules with gaps being filled (right metric) within the selected time range.
59+
* **Only rules with unfilled gaps**: Filters the Rules table to only display rules with unfilled gaps. Note that the filter excludes rules with gaps that are being filled.
60+
:::
61+
62+
:::{applies-item} { "stack": "ga 9.0" }
63+
The panel has the following:
64+
* **Time filter**: Allows you to select a time range for viewing gap data.
65+
* **Total rules with gaps:** Tells you how many rules have unfilled or partially filled gaps within the selected time range.
66+
* **Only rules with gaps**: Filters the Rules table to only display rules with unfilled or partially filled gaps.
67+
:::
5568

56-
::::{tip}
57-
For a detailed view of a rule's gaps, go to the **Execution results** tab and check the [Gaps table](/solutions/security/detect-and-alert/monitor-rule-executions.md#gaps-table).
5869
::::
5970

71+
Within the Rules table, several columns provide additional gap data:
72+
73+
* **Last Gap (if any)**: Shows how long the most recent gap for a particular rule lasted.
74+
* **Unfilled gaps duration**: Shows whether a rule still has gaps and provides a total sum of the remaining unfilled or partially filled gaps. The total sum can change based on the time range that you select during the past 90 days (data on gaps that occurred past the last 90 days is not retained). If a rule has no gaps, the columns display a dash (`––`).
75+
* {applies_to}`stack: ga 9.3`{applies_to}`serverless: ga`**Gap fill status**: Shows the status of the rule's gaps. If any gaps are unfilled, the gap status is `Unfilled`. If any gaps are being are being filled, the status is `In progress`. If all gaps are filled, the status is `Filled`.
76+
77+
::::{tip}
78+
:applies_to:{stack: ga 9.3, serverless: ga}
79+
Use the **Gap fill status** filter in the Rules table to find rules with the specified gap status.
80+
::::
81+
82+
To fill gaps for multiple rules, use the [**Fill gaps** bulk action](/solutions/security/detect-and-alert/manage-detection-rules.md#bulk-fill-gaps-multiple-rules) from the Rule's table. For a more detailed view of a rule's gaps, click the rule name to open its details, then go to the [Gaps table](/solutions/security/detect-and-alert/monitor-rule-executions.md#gaps-table) on the rule's **Execution results** tab.
83+
6084
## Execution results tab [rule-execution-logs]
6185

6286
From the **Execution results** tab, you can access the rule’s execution log, monitor and address gaps in a rule's execution schedule, and check manual runs for the rule. To find the tab, click the rule's name to open its details, then scroll down.
@@ -97,18 +121,14 @@ Use these controls to filter what’s included in the logs table:
97121
stack: preview 9.0, ga 9.1
98122
```
99123

100-
Gaps in rule executions are periods of time where a rule didn’t run. They can be caused by various disruptions, including system updates, rule failures, or simply turning off a rule. Addressing gaps is essential for maintaining consistent coverage and avoiding missed alerts.
124+
Use the information in the Gaps table to assess the scope and severity of rule execution gaps. To control what's shown in the table, you can filter the table by gap status, select a time range for viewing gap data, and sort multiple columns.
125+
126+
{applies_to}`stack: ga 9.3` Fill all gaps for the rule by clicking **Fill all gaps**.
101127

102128
::::{tip}
103129
Refer to the [Troubleshoot gaps](../../../troubleshoot/security/detection-rules.md#troubleshoot-gaps) section for strategies for avoiding gaps.
104130
::::
105131

106-
Use the information in the Gaps table to assess the scope and severity of rule execution gaps. To control what's shown in the table, you can filter the table by gap status, select a time range for viewing gap data, and sort multiple columns. In {{stack}} 9.1 and Serverless, fill all gaps for the current rule by clicking **Fill all gaps** in the Gaps table.
107-
108-
::::{note}
109-
{applies_to}`stack: ga 9.1` From the Rules table, fill gaps for multiple rules with the [**Fill gaps** bulk action](/solutions/security/detect-and-alert/manage-detection-rules.md#bulk-fill-gaps-multiple-rules).
110-
::::
111-
112132
:::{image} /solutions/images/security-gaps-table.png
113133
:alt: Gaps table on the rule execution results tab
114134
:screenshot:

0 commit comments

Comments
 (0)