Skip to content

[Alerting V2][Serverless & 9.5][M2] Add experimental alerting features overview pages#6521

Open
nastasha-solomon wants to merge 19 commits into
mainfrom
alerting/experimental-overview
Open

[Alerting V2][Serverless & 9.5][M2] Add experimental alerting features overview pages#6521
nastasha-solomon wants to merge 19 commits into
mainfrom
alerting/experimental-overview

Conversation

@nastasha-solomon

@nastasha-solomon nastasha-solomon commented May 15, 2026

Copy link
Copy Markdown
Member

Summary

Contributes to https://github.com/elastic/docs-content-internal/issues/919. This PR contains content that introduces the alerting v2 system.

Review requests

This PR needs a technical and editorial review. Instructions for each are below.

🔧 Technical reviewer

Please focus your review on accuracy of facts, names, and structure only. For example, please verify that field names, values, and descriptions in reference material are accurate and match the current implementation. When reviewing conceptual material, please check that definitions are technically accurate and reflect the current engineering design.

✏️ Editorial reviewer

This PR adds three pages that introduce the alerting v2 system alongside the existing Elastic alerting options: an overview of the experimental alerting system with a key concepts glossary, a comparison and selection guide across all three Elastic alerting systems, and an overview (alerting.md) that frames all three systems for readers arriving at the section root.

Please focus on writing quality, clarity, and how the content serves a reader who is seeing this system for the first time.

🚫 What to skip for now

Do not flag or review the following. I'll be fixing them after EAH:

Terminology

  • The glossary defines Breach as "the moment when a rule's query finds a match," but the Alert and Detect mode flow descriptions use "finds something" and "finds a match" instead. Check whether "breach" should appear in the flow descriptions to connect the terminology, or whether the current phrasing is clearer for a reader who hasn't memorized the glossary yet.

Clarity and reader framing

  • kibana-alerting-experimental.md: The "core idea" section frames the motivation as avoiding the need to edit every rule when notification routing changes. Does this land clearly for a first-time reader, or does it read more like an internal architectural concern than a user benefit?
  • choose-an-alerting-system.md: The Noise reduction row in "Compare at a glance" uses terms that require prior knowledge of the system (per-episode acknowledge or deactivate, per-series snooze, match condition routing in action policies). Check whether a reader who arrives at this page without reading the overview can make sense of this row, or whether it will only land for readers who already know the system.
Page name Description File Preview ✏️ Ready for editorial review 🔧 Ready for technical review
Experimental alerting system overview v2 alerting overview with concepts glossary explore-analyze/alerting/kibana-alerting-experimental.md Preview
Choose an alerting system Comparison and selection guide for all three Elastic alerting systems explore-analyze/alerting/choose-an-alerting-system.md Preview
Alerting Revised section overview describing all three systems with consistent naming explore-analyze/alerting.md Preview

Note on toc.yml conflicts: Each PR in this series adds entries to the same section of toc.yml. Merge these PRs in order and resolve toc.yml conflicts at each step.

🤖 Generated with Claude Code

@github-actions

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 May 15, 2026

Copy link
Copy Markdown
Contributor

@github-actions

github-actions Bot commented May 15, 2026

Copy link
Copy Markdown
Contributor

Elastic Docs Style Checker (Vale)

Summary: 1 warning found

⚠️ Warnings (1): Fix when the suggestion improves clarity or correctness.
File Line Rule Message
explore-analyze/alerting/kibana-alerting-experimental.md 120 Elastic.Spelling 'cooldown' is a possible misspelling.

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.

- alerting.md: updated section overview for all three alerting systems
- alerting/choose-an-alerting-system.md: new comparison and selection guide
- alerting/kibana-alerting-experimental.md: new experimental alerting features overview with concepts glossary and Dispatcher entry
- explore-analyze/images/rule-alert-mode-diagram.png, rule-detect-mode-diagram.png: new diagrams
- toc.yml: navigation entries for new pages

Applies naming guidelines throughout. Cross-references to pages in later PRs are commented out with TODO notes.

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@nastasha-solomon nastasha-solomon force-pushed the alerting/experimental-overview branch from 5e76dfb to ff31898 Compare May 15, 2026 20:45
nastasha-solomon added a commit that referenced this pull request May 15, 2026
…6521

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
nastasha-solomon added a commit that referenced this pull request May 15, 2026
…fter PR #6521

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@nastasha-solomon nastasha-solomon self-assigned this May 15, 2026
@nastasha-solomon nastasha-solomon changed the title Add experimental alerting features overview pages [Alerting V2][Serverless & 9.5][M2] Add experimental alerting features overview pages May 18, 2026
nastasha-solomon added a commit that referenced this pull request May 28, 2026
… alerting pages (#6526)

## Summary

Contributes to
elastic/docs-content-internal#919.

Updates five existing Kibana alerting pages in `alerting/alerts/` to
consistently use "Kibana alerting" as the primary term, per the alerting
naming guidelines:

- `alerts.md`: rename H1 to "Kibana alerting", add opening paragraph
establishing the system identity, add cross-reference to experimental
alerting features
- `alerting-getting-started.md`: rename H1 to "Getting started with
Kibana alerting", update first sentence
- `alerting-setup.md`: rename H1 to "Set up Kibana alerting", add anchor
sentence
- `create-manage-rules.md`: rename H1 to include "Kibana alerting"
- `view-alerts.md`: rename H1 to include "Kibana alerting", update intro
sentence

**Why**: The naming guidelines establish "Kibana alerting" as the
primary term for the existing alerting system to distinguish it from the
experimental alerting features. Every page should identify its system in
the first paragraph so search engines and AI retrieval can surface the
right content.

This PR is independent and can be merged on its own. It is part of the
broader series replacing [PR
#5528](#5528).


## Test plan

- [ ] Confirm no "Kibana alerting v1" in modified files
- [ ] Verify the cross-reference in `alerts.md` to
`kibana-alerting-experimental.md` is correct (resolves once PR #6521 is
merged)
- [ ] Check H1 changes don't break any existing anchor links (H1 anchors
not changed)

🤖 Generated with [Claude Code](https://claude.com/claude-code)

---------

Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com>
@nastasha-solomon nastasha-solomon marked this pull request as ready for review May 28, 2026 21:15
@nastasha-solomon nastasha-solomon requested a review from a team as a code owner May 28, 2026 21:15
@alaudazzi

Copy link
Copy Markdown
Contributor

A few suggestions for your consideration:

1/ The landing page could be simplified :
- Explain what the alerting system is
- Introduce the three alerting systems (kibana, experimental, watcher) with a shorter paragraph + link to the relevant get started
- Highlight how you can choose among the three systems (this only appears in the TOC)
- Reduce the number of admonitions (Note, Tips)

2/ To make content more actionable, consider using the "stepper" feature in the various sections under Kibana alerting (Getting started with alerts, Set up, Create and manage rules, View and manage alerts, Query alert indices)

3/ On the explore-analyze/alerting.md there seems to be a mismatch across H2


image

@alaudazzi alaudazzi left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice work! I left a few suggestions, mainly related to the overall structure and navigation.
Shall we also reconsider the quantity of admonitions? On the View and manage alerts from Kibana alerting rules page there are 3 Notes, 3 Tips, 1 Important, and 1 Warning.

@alexandra5000 alexandra5000 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not really familiar with alerting, but I left some comments anyway 😎 Take them or leave them!

The one I feel is maybe the most important is the one regarding the "core idea" section, which should be easily understandable even for a person with little to no prior knowledge on the subject. You may not see it as confusing because of your familiarity with the subject matter.

Comment thread explore-analyze/alerting/choose-an-alerting-system.md
Comment thread explore-analyze/alerting/choose-an-alerting-system.md Outdated
| **Rule definition** | Select a rule type and fill in parameters | Write an {{esql}} query | Write a JSON watch definition |
| **Alert data** | In-place updates; limited query support | Append-only events queryable with {{esql}} in Discover | Watch history index |
| **Notifications** | Configured per action on each rule | Centralized action policies, reusable across rules | Action-level throttling and conditions |
| **Noise reduction** | Snooze per rule, maintenance windows | Per-episode acknowledge or deactivate; per-series snooze; maintenance windows; match condition routing in action policies | Action conditions and throttling |

@alexandra5000 alexandra5000 Jun 1, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
| **Noise reduction** | Snooze per rule, maintenance windows | Per-episode acknowledge or deactivate; per-series snooze; maintenance windows; match condition routing in action policies | Action conditions and throttling |
| **Noise reduction** | Snooze per rule, maintenance windows | Per-episode acknowledge or deactivate; per-series snooze; maintenance windows; match condition routing in action policies. Refer to [{{alerting-v2-system-cap}} overview](kibana-alerting-experimental.md) for more information | Action conditions and throttling |

I know you're aware of it being rather jargon-y and hard to understand "at a glance", I also get why you wouldn't want to clutter the table, but maybe a link here wouldn't hurt? But if you feel the target reader/user will know what that's about, then it may not be necessary after all.

Comment thread explore-analyze/alerting/kibana-alerting-experimental.md Outdated
Comment thread explore-analyze/alerting/kibana-alerting-experimental.md Outdated
Comment thread explore-analyze/alerting/kibana-alerting-experimental.md Outdated
Comment thread explore-analyze/alerting/kibana-alerting-experimental.md Outdated
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants