-
Notifications
You must be signed in to change notification settings - Fork 245
[Alerting V2][Serverless & 9.5][M2] Add experimental alerting features overview pages #6521
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
Open
nastasha-solomon
wants to merge
40
commits into
main
Choose a base branch
from
alerting/experimental-overview
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
40 commits
Select commit
Hold shift + click to select a range
ff31898
Add experimental alerting features overview pages
nastasha-solomon 3d56dce
Add alerting-v2 variables and replace phrase throughout
nastasha-solomon 2439f79
naming
nastasha-solomon d013baf
Merge branch 'main' into alerting/experimental-overview
nastasha-solomon 0634d41
update vars
nastasha-solomon c1e1f82
Merge branch 'alerting/experimental-overview' of https://github.com/e…
nastasha-solomon 57eef48
Merge branch 'main' into alerting/experimental-overview
nastasha-solomon a8ddf6b
Update variables and addresses editorial feedback for alerting v2 ove…
nastasha-solomon 2c849a9
Merge branch 'main' into alerting/experimental-overview
nastasha-solomon 5c4177e
Merge branch 'main' into alerting/experimental-overview
nastasha-solomon 2238339
Terminology refresh
nastasha-solomon 5a8dbfb
align with action policy docs
nastasha-solomon b09b071
Merge branch 'main' into alerting/experimental-overview
nastasha-solomon a1432c1
Merge branch 'main' into alerting/experimental-overview
nastasha-solomon 41f709b
editorial feedback
nastasha-solomon cad7e8b
Merge branch 'main' into alerting/experimental-overview
nastasha-solomon bf7e0b0
update applies_to tags
nastasha-solomon bc0baa3
Updates modes
nastasha-solomon c4a9600
Merge branch 'main' into alerting/experimental-overview
nastasha-solomon 8d89a4b
Merge branch 'main' into alerting/experimental-overview
nastasha-solomon 8531a94
[Alerting V2][Serverless & 9.5][M2] Prep overview page for incoming c…
nastasha-solomon c4e993f
fix variables
nastasha-solomon aeb19c8
tia's feedback
nastasha-solomon 0502809
comment out image
nastasha-solomon 68b1a74
Update explore-analyze/alerting/kibana-alerting-experimental.md
nastasha-solomon 4dee0b7
Update explore-analyze/alerting/kibana-alerting-experimental.md
nastasha-solomon e892efc
Jason's feedback
nastasha-solomon 7679ea1
Update explore-analyze/alerting/kibana-alerting-experimental.md
nastasha-solomon 86b1b9c
Merge branch 'main' into alerting/experimental-overview
nastasha-solomon 6cbf2be
Merge branch 'main' into alerting/experimental-overview
nastasha-solomon b288e77
[Alerting V2][Serverless & 9.5][M2] Simplifies alerting overview and …
nastasha-solomon 46a62f8
changing "choose" to "compare"
nastasha-solomon dc5be82
move kibana v2 alerting up
nastasha-solomon d89c47d
Remove colon
nastasha-solomon 60a98ac
Merge branch 'main' into alerting/experimental-overview
nastasha-solomon fb4dd92
Merge branch 'main' into alerting/experimental-overview
nastasha-solomon c1e9ca9
Merge branch 'main' into alerting/experimental-overview
nastasha-solomon c538943
Apply suggestions from code review
nastasha-solomon 8c6cd77
Merge branch 'main' into alerting/experimental-overview
nastasha-solomon 215b2a7
Fix note
nastasha-solomon File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
nastasha-solomon marked this conversation as resolved.
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,53 @@ | ||
| --- | ||
| navigation_title: Compare alerting systems | ||
| applies_to: | ||
| stack: ga | ||
| serverless: ga | ||
|
nastasha-solomon marked this conversation as resolved.
|
||
| products: | ||
| - id: kibana | ||
| - id: cloud-serverless | ||
| - id: elasticsearch | ||
| - id: cloud-hosted | ||
| description: Compare Kibana alerting, the experimental ES|QL-based alerting system, and Watcher by use case and deployment type to select the right tool for your monitoring needs. | ||
| --- | ||
|
|
||
| # Compare alerting systems [compare-alerting-systems] | ||
|
|
||
| Elastic offers three alerting systems, each suited to different use cases and workflows. For most new projects and projects on the most recent {{kib}} versions, the {{alerting-v2-system}} is the recommended system. Use this page to compare them by goal, feature, and availability. | ||
|
|
||
| ## Select by use case | ||
|
|
||
| | Goal | Suggested system | Availability | | ||
| |---|---|---| | ||
| | Monitor metrics, logs, or uptime with ready-made rules and no query language | [{{kib}} alerting](alerts.md) | {applies_to}`stack: ga` {applies_to}`serverless: ga` | | ||
| | Use rules built for {{elastic-sec}}, {{observability}}, APM, or Maps | [{{kib}} alerting](alerts.md) | {applies_to}`stack: ga` {applies_to}`serverless: ga` | | ||
| | Write {{esql}} to define exactly what to detect and what data each alert episode carries | [{{alerting-v2-system-cap}}](kibana-alerting-experimental.md) | {applies_to}`serverless: experimental` {applies_to}`stack: experimental 9.5+` | | ||
| | Query alert history in Discover or build dashboards from alert data | [{{alerting-v2-system-cap}}](kibana-alerting-experimental.md) | {applies_to}`serverless: experimental` {applies_to}`stack: experimental 9.5+` | | ||
| | Manage notification routing, grouping, and throttling in one place, reusable across rules | [{{alerting-v2-system-cap}}](kibana-alerting-experimental.md) | {applies_to}`serverless: experimental` {applies_to}`stack: experimental 9.5+` | | ||
| | Build highly custom notification logic with reusable, configurable workflows | [{{alerting-v2-system-cap}}](kibana-alerting-experimental.md) | {applies_to}`serverless: experimental` {applies_to}`stack: experimental 9.5+` | | ||
| | Build highly custom logic with scripting and chained inputs | [Watcher](watcher.md) | {applies_to}`stack: ga` {applies_to}`serverless: unavailable` | | ||
|
|
||
| ## Compare at a glance | ||
|
|
||
| | | {{kib}} alerting | {{alerting-v2-system-cap}} | Watcher | | ||
| |---|---|---|---| | ||
| | **Best for** | Teams using built-in rule types with form-based setup | Teams that need full control over detection and notification routing | Custom alerting logic requiring scripting | | ||
| | **Rule definition** | Select a rule type and fill in parameters | Write an {{esql}} query or use a rule builder with form-based setup | 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; supports action-level throttling and conditions | 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 | | ||
| | **Available on {{serverless-full}}** | Yes | Yes, {applies_to}`serverless: experimental` | No | | ||
| | **Available on {{stack}}** | Yes | Yes, {applies_to}`stack: experimental 9.5+` | Yes | | ||
|
|
||
| <!-- | ||
| TODO: Once PRs #6523, #6525, and #6527 are merged, add cross-links to the experimental system cells in the comparison table above. The cells currently describe the system but don't link anywhere. Suggested targets: | ||
|
|
||
| | Row | Link target | | ||
| |----------------------------|-----------------------------------------------------------------------------| | ||
| | Alert data (experimental) | kibana-alerting-experimental/alerts/query-alerts-and-signals-in-discover.md (PR #6527) | | ||
| | Notifications (experimental) | kibana-alerting-experimental/notifications-actions.md or action-policies/about-action-policies.md (PR #6525) | | ||
| | Noise reduction (experimental) | kibana-alerting-experimental/action-policies/reduce-notification-noise.md (PR #6525) | | ||
| | Rule definition (experimental) | kibana-alerting-experimental/rules/configure-rule-query.md (PR #6523) | | ||
|
|
||
| Also add links to the experimental system rows in the "Select by use case" table once the relevant pages are available. | ||
| --> | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,88 @@ | ||
| --- | ||
| navigation_title: Experimental alerting system | ||
| applies_to: | ||
| stack: experimental 9.5+ | ||
| serverless: experimental | ||
| products: | ||
| - id: kibana | ||
| - id: cloud-serverless | ||
| description: The experimental Kibana alerting system uses ES|QL rules to detect conditions, track problems as alert episodes, and route notifications through reusable action policies. | ||
| --- | ||
|
|
||
| # {{alerting-v2-system-cap}} overview [alerting-overview] | ||
|
|
||
| The {{alerting-v2-system}} in {{kib}} watches your {{es}} data continuously, so your team doesn't have to. You define the conditions that matter, such as when to open an issue, who should know, and how often to notify them. The system handles the rest. | ||
|
|
||
| ::::{note} | ||
| In the generally available {{kib}} alerting system, the term *alert* refers to a tracked occurrence of a rule condition. In the {{alerting-v2-system}}, the equivalent concept is called an *alert episode*. The two terms describe similar ideas in different systems and are not interchangeable. | ||
| :::: | ||
|
|
||
| ## The core idea [kibana-alerting-v2-overview] | ||
|
|
||
| The {{alerting-v2-system}} separates *detecting* a problem from *acting* on it: | ||
|
|
||
| - **Detecting** - Rules focus purely on what to watch for in your data and on collecting breach and recovery events. | ||
| - **Acting** - Action policies handle who gets notified, when, and how, independently of any rule. | ||
|
|
||
| You can build and test detection logic before wiring up any notifications, and update notification routing across all rules in one place without editing the rules themselves. | ||
|
|
||
| ## The four building blocks | ||
|
|
||
| The {{alerting-v2-system}} is built around four objects: rules, alert episodes, action policies, and workflows, each with a distinct role. | ||
|
|
||
| ### Rules | ||
|
|
||
| A rule defines what to watch for in your data and how often to check. Every rule runs in one of two modes: alert or signal. | ||
|
|
||
| - **Alert** - Opens an alert episode when the rule finds a match and closes it when the condition clears, notifying your team at each episode state change. Helpful when you want to follow a problem from first detection to resolution. | ||
| - **Signal** - Records rule query results over time without opening episodes or sending notifications. Helps you build a baseline, spot trends, or collect evidence before deciding whether something is worth alerting on. | ||
|
|
||
| <!-- TODO: When PR #6523 (rules) merges, uncomment the link below and trim this sub-section to 1–2 anchor sentences + the link. | ||
| Refer to [Rules](kibana-alerting-experimental/rules.md) to learn more. | ||
| --> | ||
|
|
||
| ### Alert episodes | ||
|
|
||
| In Alert mode, the rule opens one alert episode per problem and keeps it open until the condition clears. The alert episode moves through states (pending, active, recovering, inactive) giving you one lifecycle to triage rather than a separate item per rule check. | ||
|
|
||
| <!-- TODO: When PR #6527 (alerts) merges, uncomment the link below and trim this sub-section to 1–2 anchor sentences + the link. | ||
| Refer to [Alert episodes](kibana-alerting-experimental/alerts.md) to learn more. | ||
| --> | ||
|
|
||
| ### Action policies | ||
|
|
||
| An action policy is the gating layer between an alert episode and a workflow. It decides whether and when to invoke a workflow by evaluating suppression, match conditions, and frequency. Policy configuration determines the scope. A policy can apply to alert episodes from a specific rule, multiple rules, or all rules in the space. | ||
|
|
||
| <!-- TODO: When PR #6525 (workflows/notifications) merges, uncomment the link below and trim this sub-section to 1–2 anchor sentences + the link. | ||
| Refer to [Notifications and actions](kibana-alerting-experimental/notifications-actions.md) to learn more. | ||
| --> | ||
|
|
||
| ### Workflows | ||
|
|
||
| A workflow is what actually sends the message or runs the automation, for example, posting to Slack, sending an email, calling a webhook. The {{alerting-v2-system}} invokes workflows through action policies that you configure to trigger on a schedule or on a state change on an alert episode. | ||
|
|
||
| <!-- TODO: When PR #6525 (workflows/notifications) merges, uncomment the link below and trim this sub-section to 1–2 anchor sentences + the link. | ||
| Refer to [Connect workflows](kibana-alerting-experimental/workflows-alerting.md) to learn more. | ||
| --> | ||
|
|
||
| ## How the pieces fit together [how-pieces-fit-together] | ||
|
|
||
| At the simplest level: | ||
|
|
||
| 1. A rule checks your data on a schedule. | ||
| 2. The rule's query returns results when data matching its conditions is found. | ||
| 3. The rule's mode determines what happens next: | ||
| - **Alert** - The rule opens an alert episode to track the problem. An action policy can route it to a workflow to perform an action or send a notification. | ||
| - **Signal** - Each result is recorded for querying later. Nothing else happens. | ||
|
|
||
| For a more detailed explanation of each stage, refer to [How the {{alerting-v2-system}} works](kibana-alerting-experimental/how-it-works.md). | ||
|
|
||
| ## Next steps | ||
|
|
||
| <!-- TODO: When PRs #6523, #6525, and #6527 merge, replace the paragraph below with these three forward-facing tracks and remove the compare-alerting-systems link (it points here, not forward): | ||
| - **Rules**: Refer to [Rules](kibana-alerting-experimental/rules.md) to learn how to create and configure detection rules. | ||
| - **Alerts**: Refer to [Alerts](kibana-alerting-experimental/alerts.md) to learn how alert episodes work and how to triage them. | ||
| - **Notifications**: Refer to [Notifications and actions](kibana-alerting-experimental/notifications-actions.md) to learn how action policies and workflows route notifications. | ||
| --> | ||
|
|
||
| To understand how the {{alerting-v2-system}} fits into {{kib}}'s alerting options, refer to [Alerting](../alerting.md) or [Compare alerting systems](compare-alerting-systems.md). |
71 changes: 71 additions & 0 deletions
71
explore-analyze/alerting/kibana-alerting-experimental/glossary.md
|
Member
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. :standing-ovation-gif: |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,71 @@ | ||
| --- | ||
| navigation_title: Glossary | ||
| applies_to: | ||
| stack: experimental 9.5+ | ||
| serverless: experimental | ||
| products: | ||
| - id: kibana | ||
| - id: cloud-serverless | ||
| description: Definitions of key terms used throughout the experimental Kibana alerting system documentation. | ||
| --- | ||
|
|
||
| # {{alerting-v2-system-cap}} glossary [alerting-v2-glossary] | ||
|
|
||
| These terms appear throughout the {{alerting-v2-system}} docs. If a term is unclear while reading, check its definition here before going further. | ||
|
|
||
| **Action policy** | ||
| : A configuration that controls whether and how often an alert episode triggers a notification, including which alerts qualify and how to avoid sending too many notifications. A single action policy can apply to one rule, several rules, or all rules in the space. | ||
| <!-- TODO: Uncomment when PR #6525 (workflows/notifications) is merged: | ||
| To learn more, refer to [Notifications and actions](notifications-actions.md). | ||
| --> | ||
|
|
||
| **Alert episode** | ||
| : The complete record of one problem tracked in Alert mode, from first detection to recovery, moving through states (pending, active, recovering, inactive). | ||
|
|
||
| **Breach** | ||
| : A single instance when a rule's query finds a match, which may or may not open an alert episode depending on how the rule is configured. | ||
|
Check notice on line 26 in explore-analyze/alerting/kibana-alerting-experimental/glossary.md
|
||
|
|
||
| **Dispatcher** | ||
| : The background process that evaluates action policies against active alert episodes on a short interval (around 5 seconds), independent of the rule schedule. | ||
| <!-- TODO: Uncomment when PR #6525 (workflows/notifications) is merged: | ||
| To learn more, refer to [Reduce notification noise](action-policies/reduce-notification-noise.md). | ||
| --> | ||
|
|
||
| **{{esql}}** | ||
| : The query language every rule uses to search your data. To learn more, refer to the [{{esql}} reference](elasticsearch://reference/query-languages/esql.md). | ||
|
|
||
| **Notification** | ||
| : The message or action delivered when an alert episode matches an action policy and a workflow sends it, such as a Slack message, an email, or a webhook call. | ||
| <!-- TODO: Uncomment when PR #6525 (workflows/notifications) is merged: | ||
| To learn more, refer to [How action policies are evaluated](notifications-actions.md#how-action-policies-evaluated). | ||
| --> | ||
|
|
||
| **Rule** | ||
| : The definition of what to watch for in your data, how often to check, and what counts as a match; runs on a schedule and produces signals (Signal mode) or tracks alert episodes (Alert mode). | ||
| <!-- TODO: Uncomment when PR #6523 (rules) is merged: | ||
| To learn more, refer to [Rules](rules.md). | ||
| --> | ||
|
|
||
| **Rule event** | ||
| : A record written to `.rule-events` every time a rule runs and its query finds a match; in Signal mode it is a signal, in Alert mode it belongs to an alert episode. | ||
|
|
||
| **Severity** | ||
| : A label attached to alert episodes to indicate urgency; available as a filter in action policies so critical episodes can be routed differently from low-priority ones. | ||
| <!-- TODO: Uncomment when PR #6523 (rules) is merged: | ||
| To learn more, refer to [Configure rule severity](rules/configure-rule-severity.md). | ||
| --> | ||
|
|
||
| **Signal** | ||
| : A rule event recorded in Signal mode; stored and queryable in Discover but doesn't open an alert episode or trigger notifications. | ||
|
|
||
| **Threshold** | ||
| : The condition a rule uses to decide when something is worth alerting on, including how many times the condition must be met before an alert episode opens or closes. | ||
| <!-- TODO: Uncomment when PR #6523 (rules) is merged: | ||
| To learn more, refer to [Activation and recovery thresholds](rules/configure-rule-thresholds.md). | ||
| --> | ||
|
|
||
| **Workflow** | ||
| : The automation that sends a message or runs an action when an action policy decides a notification should go out, such as posting to Slack, sending an email, or calling a webhook. | ||
| <!-- TODO: Uncomment when PR #6525 (workflows/notifications) is merged: | ||
| To learn more, refer to [Connect workflows](workflows-alerting.md). | ||
| --> | ||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.