Skip to content

Clarify delayed-rule catch-up behavior before gaps are recorded in Security rule monitoring docs - #7830

Closed
bmorelli25 with Copilot wants to merge 4 commits into
mainfrom
copilot/docs-explain-catch-up-search-window
Closed

Clarify delayed-rule catch-up behavior before gaps are recorded in Security rule monitoring docs#7830
bmorelli25 with Copilot wants to merge 4 commits into
mainfrom
copilot/docs-explain-catch-up-search-window

Conversation

Copilot AI commented Aug 6, 2026

Copy link
Copy Markdown
Contributor

The docs for rule monitoring and gap filling did not explain why a rule can show scheduling delay while gap duration remains empty/zero. This update documents the catch-up window behavior so users can distinguish expected delay recovery from true coverage gaps.

  • What was missing

    • Added explicit guidance that delayed executions can backfill missed time before a gap is recorded.
    • Clarified that only delay beyond the catch-up ceiling becomes a recorded gap.
  • monitor-rule-executions.md updates (Scheduling and gaps)

    • Added a note under Scheduling and gaps explaining:
      • late runs may still have 0 Gap duration
      • catch-up extends the source window by up to four additional interval-sized windows
      • gap recording starts only after that capacity is exceeded
    • Added a concrete sizing example with derivation:
    (4 × 5m) + 6m = 26m
    
  • fill-rule-gaps.md updates (Gap information)

    • Added a companion note in Gap information explaining:
      • Scheduling delay can be present while Unfilled gaps duration is empty/0
      • this is expected when catch-up covers the missed period
      • only remaining delay beyond catch-up is recorded as a gap

Copilot AI and others added 2 commits August 6, 2026 21:06
Co-authored-by: bmorelli25 <5618806+bmorelli25@users.noreply.github.com>
Co-authored-by: bmorelli25 <5618806+bmorelli25@users.noreply.github.com>
Copilot AI changed the title [WIP] Update docs to explain catch-up search window before gaps are recorded Clarify delayed-rule catch-up behavior before gaps are recorded in Security rule monitoring docs Aug 6, 2026
Copilot AI requested a review from bmorelli25 August 6, 2026 21:08
@bmorelli25

Copy link
Copy Markdown
Member

@nastasha-solomon this one felt well scoped enough for me to throw copilot at. If we're too far off, close this and we can reassess.

@bmorelli25
bmorelli25 marked this pull request as ready for review August 6, 2026 21:12
@bmorelli25
bmorelli25 requested a review from a team as a code owner August 6, 2026 21:12
@nastasha-solomon
nastasha-solomon marked this pull request as draft August 7, 2026 02:08
@nastasha-solomon
nastasha-solomon marked this pull request as ready for review August 7, 2026 02:08
@github-actions

github-actions Bot commented Aug 7, 2026

Copy link
Copy Markdown
Contributor

Elastic Docs AI PR menu

Check the box to run an AI review for this pull request.

  • Review docs changes (docs-review). Status: not started.

Powered by GitHub Agentic Workflows and docs-actions. For more information, reach out to the docs team.

@github-actions

github-actions Bot commented Aug 7, 2026

Copy link
Copy Markdown
Contributor

@github-actions

github-actions Bot commented Aug 7, 2026

Copy link
Copy Markdown
Contributor

✅ Elastic Docs Style Checker (Vale)

No issues found on modified lines!


The Vale linter checks documentation changes against the Elastic Docs style guide. To use Vale locally or report issues, refer to Elastic style guide for Vale.

@nastasha-solomon

Copy link
Copy Markdown
Member

@bmorelli25 I'm not the biggest fan of the updates that copilot made. I read the doc issue as: users want to know if rules running on a late schedule (e.g., they were queued or took a long time to execute) extend their search window to cover the "missed" time window. The updates don't explicitly confirm this, and instead jump to explaining how the rule's catch-up window works and what the UI displays. I'd like to take a whack at this PR when I'm back from PTO and/or consider how to better direct copilot with these types of updates.

@bmorelli25

Copy link
Copy Markdown
Member

Works for me! Thanks!

@bmorelli25 bmorelli25 closed this Aug 7, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Docs: explain catch-up search window before gaps are recorded (monitor-rule-executions / fill-rule-gaps)

3 participants