-
Notifications
You must be signed in to change notification settings - Fork 190
[Security][Gap Fill][9.3 & Serverless]: Docs recent additions for gap fill feature #4403
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
base: main
Are you sure you want to change the base?
Conversation
✅ Vale Linting ResultsNo issues found on modified lines! |
🔍 Preview links for changed docs |
…-content into issue-3969-gaps-pt1
benironside
left a comment
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.
I like the edits, structurally it makes sense and I only found a couple minor edits to suggest.
|
|
||
| ::::{tip} | ||
| :applies_to:{stack: ga 9.3, serverless: ga} | ||
| Use the **Gap fill status** filter in the Rules table to find rules with the gap status you specify. |
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.
| Use the **Gap fill status** filter in the Rules table to find rules with the gap status you specify. | |
| Use the **Gap fill status** filter in the Rules table to find rules with the specified gap status. |
| ``` | ||
|
|
||
| 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. | ||
| 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. {applies_to}`stack: ga 9.3` Fill all gaps for the rule by clicking **Fill all gaps**. |
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.
| 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. {applies_to}`stack: ga 9.3` Fill all gaps for the rule by clicking **Fill all gaps**. | |
| 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. | |
| {applies_to}`stack: ga 9.3` Fill all gaps for the rule by clicking **Fill all gaps**. |
Brandon shared a best practice with me recently which is to not have applies to labels be inline. I think this makes it a bit more clear what the applies to... applies to ![]()
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.
There's a
emoji?!
|
|
||
| * {applies_to}`stack: ga 9.0` **Only rules with gaps**: Filters the Rules table to only display rules with unfilled or partially filled gaps. | ||
| * {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. | ||
| 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, rule failures, or simply turning off a rule. Addressing gaps is essential for maintaining consistent coverage and avoiding missed alerts. |
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.
rule failures - can't cause a gap at the moment
| Within the Rules table, several columns provide additional gap data: | ||
|
|
||
| * **Last Gap (if any)**: Shows how long the most recent gap for a particular rule lasted. | ||
| * **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 selected time range. If a rule has no gaps, the columns display a dash (`––`). |
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.
The total sum can change based on the selected time range.
it's 90 days also
|
|
||
| * **Last Gap (if any)**: Shows how long the most recent gap for a particular rule lasted. | ||
| * **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 selected time range. If a rule has no gaps, the columns display a dash (`––`). | ||
| * {applies_to}`stack: ga 9.3`{applies_to}`serverless: ga`**Gap fill status**: Shows the status of the rule's gaps. If a rule has any unfilled gaps, the gap status is `Unfilled`. If all gaps for the rule are being are being filled, the status is `In progress`. Once all gaps have been filled, the status changes `Filled`. |
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.
If all gaps for the rule are being are being filled, the status is
In progress.
I think we should worded this section more clearly to show how this status works, because it's not entirely correct now.
IF any gap is unfilled THEN show Unfilled
ELSE IF any gaps are being filled THEN SHOW In progress
ELSE show Filled
Summary
Contributes to #3969 by documenting the following UI changes that have been released in Serverless:
Note that within the "Rule Monitoring" section, content about rule gaps has been moved under a new sub-section titled "Find rule execution gaps" and the information has been slightly re-organized to show when certain functionality is available.
Generative AI disclosure