[Alerting V2][Serverless & 9.5][M2] Add get started pages for the experimental alerting system#6522
[Alerting V2][Serverless & 9.5][M2] Add get started pages for the experimental alerting system#6522nastasha-solomon wants to merge 26 commits into
Conversation
Elastic Docs AI PR menuCheck the box to run an AI review for this pull request.
Powered by GitHub Agentic Workflows and docs-actions. For more information, reach out to the docs team. |
Elastic Docs Style Checker (Vale)Summary: 1 warning, 1 suggestion found
|
| File | Line | Rule | Message |
|---|---|---|---|
| explore-analyze/alerting/kibana-alerting-experimental/get-started/create-your-first-rule.md | 262 | Elastic.DontUse | Don't use 'just'. |
💡 Suggestions (1): Optional style improvements. Apply when helpful.
| File | Line | Rule | Message |
|---|---|---|---|
| explore-analyze/alerting/kibana-alerting-experimental/get-started/configure-access.md | 26 | Elastic.Ellipses | In general, don't use an ellipsis. |
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.
Adds three setup pages under kibana-alerting-experimental/: - quick-start-alerting.md: step-by-step first rule guide - setup-alerting.md: full setup covering data streams, spaces, and API keys - alerting-privileges.md: privilege requirements 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
force-pushed
the
alerting/experimental-setup
branch
from
18160ec to
6d1db26
Compare
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
nastasha-solomon
changed the title
…ted.md Co-authored-by: Visha Angelova <91186315+vishaangelova@users.noreply.github.com>
…ted/create-your-first-rule.md
…ted/create-your-first-rule.md Co-authored-by: Visha Angelova <91186315+vishaangelova@users.noreply.github.com>
…ution history docs to rules pages (#7247) ## Summary Adds two missing documentation gaps to the experimental alerting rules section, addressing issues [#7227](#7227) and [#7240](#7240). Both pages are in the in-progress PR [#6523](#6523). --- ## Content changes ### `rules/create-rules-action-policies-agent-builder.md` Addresses [#7227](#7227): Added a **Requirements** section before "Propose and save a rule" covering the three conditions that must be met for the "Create with AI Agent" entry points to appear in the {{alerting-v2-system}} UI: - **The required subscription**: Agent Builder requires the appropriate Stack subscription or Serverless project feature tier. Without it, the entry points are hidden. - **The `agentBuilder:experimentalFeatures` advanced setting turned on**: The alerting v2-specific UI gate, enabled in Advanced Settings. Added following the Kibana PR [#274165](elastic/kibana#274165) which introduced this as a hard gate on all four "Create with AI Agent" entry points (rules list split-button, empty state, and both create-rule flyouts). - **The required privileges**: A table covering the four privilege requirements — `Agent Builder: Read` to access the agent, `Rules: All` to save a rule, `Action Policies: All` to save an action policy, and `Workflows: Read` or `Workflows: All` to select or create a workflow destination. A cross-reference link to `configure-access.md` is included but commented out pending PR [#6522](#6522). Requirements section is modeled on the `create-your-first-rule.md` pattern from PR [#6522](#6522). --- ### `rules/view-manage-rules.md` Addresses [#7240](#7240): Added a **Monitor rule execution health** section documenting the Execution History page and its Rules tab, introduced in Kibana PR [#275066](elastic/kibana#275066). - Describes the Execution History page as a cross-rule view for monitoring rule health at scale. - Documents the two-tab layout: **Rules** (default) and **Policies**. - Documents the **Rules** tab columns: Timestamp, Rule (links to rule summary flyout), Duration, Response, and Message. - Documents the server-side **Outcome** filter (All / Success / Failure) and the 10,000-record result cap. Updated the page description and opening paragraph to reflect the new coverage. ## Generative AI disclosure 1. Did you use a generative AI (GenAI) tool to assist in creating this contribution? - [x] Yes — Cursor + Claude - [ ] No
cnasikas
left a comment
cnasikas
left a comment
There was a problem hiding this comment.
LGMT! Great to see docs for alerting v2! A note that we disable alerting v2 in serverless due to an incident with billing. We are expecting to enable it soon. Also, in the "Confirm the rule is evaluating" section, shouldn't we promote the UI instead of searching the docs in the .rule-events? Lastly, I am sure there is a good reason, but why is the alerting v2 section called "Get started" and not "Alerting v2" or similar?
Yes, great point. The rule execution history tab is the faster and more user-friendly path. I'll remove the suggestion to go to Discover and replace it with instructions to check the execution history page.
Yeah, this is a little funky. The "Get started" section is a level too high right now because of how the alerting v2 docs are broken up. Once I merge the PR that has the section landing page for the alerting v2 docs, "Get started" will be moved to it's proper placement in the TOC like this:
|
I was thinking of the alerts table, the alerts detail page, etc. There are a lot of views there where they can see the lifecycle of the episode, etc. |
Co-authored-by: Nastasha Solomon <79124755+nastasha-solomon@users.noreply.github.com>
Co-authored-by: Nastasha Solomon <79124755+nastasha-solomon@users.noreply.github.com>
5 participants
Summary
Adds the "Get started" section for the experimental alerting system, contributing to docs-content-internal#919. Following the tech preview principle of accuracy over comprehensiveness, pages focus on stable behavior (e.g., how to enable the system, what privileges are needed, and how to create a first rule) rather than comprehensive feature documentation that is subject to change before GA. Some UI is doc'd in the tutorial, but that's needed for users to follow along.
Navigation structure
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.
✏️ Editorial reviewer
Focus on writing quality, clarity, and how the content serves a reader enabling and using this feature for the first time.
Previews — 📁 New v2 content
Get started
applies-switchfor turning the system on (Serverless only for now) and off; confirmation steps; next stepsreadaccess via Alerts privilege for.rule-events/.alert-actions; custom role still required for.kibana-event-log-*; Next stepsOut of scope for this PR
Cross-references to content in those PRs are present throughout these pages but commented out with TODO notes.
Generative AI disclosure