-
Notifications
You must be signed in to change notification settings - Fork 245
[Alerting V2][Serverless & 9.5][M2] Add get started pages for the experimental alerting system #6522
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
Merged
Merged
[Alerting V2][Serverless & 9.5][M2] Add get started pages for the experimental alerting system #6522
Changes from all commits
Commits
Show all changes
37 commits
Select commit
Hold shift + click to select a range
6d1db26
Add experimental alerting features setup pages
nastasha-solomon 62b60c5
Add alerting-v2 variables and replace phrase throughout
nastasha-solomon 35b2d53
Merge branch 'main' into alerting/experimental-setup
nastasha-solomon d344c4c
updates applies_to tags
nastasha-solomon e2eb9cd
Merge branch 'main' into alerting/experimental-setup
nastasha-solomon 7d2c2ef
Merge branch 'main' into alerting/experimental-setup
nastasha-solomon 3e79665
Merge branch 'main' into alerting/experimental-setup
nastasha-solomon 75a3e34
Merge branch 'main' into alerting/experimental-setup
nastasha-solomon e10ecba
[Alerting V2][Serverless & 9.5][M2] Setup changes from July 2 (#7181)
nastasha-solomon 55abcad
minor tweaks
nastasha-solomon 533118d
Merge branch 'main' into alerting/experimental-setup
nastasha-solomon 74d1716
[Alerting V2][Serverless & 9.5][M2] Edit and improve get-started docs…
nastasha-solomon 06512c0
Merge branch 'main' into alerting/experimental-setup
nastasha-solomon a4174e6
Apply suggestion from @nastasha-solomon
nastasha-solomon 8a8f120
tia's feedback round 2
nastasha-solomon d59c78f
Adding note about turning off in serverless
nastasha-solomon 1d7e9e5
Update explore-analyze/alerting/kibana-alerting-experimental/get-star…
nastasha-solomon 02d7314
Update explore-analyze/alerting/kibana-alerting-experimental/get-star…
nastasha-solomon 710c8bb
Update explore-analyze/alerting/kibana-alerting-experimental/get-star…
nastasha-solomon 9f86278
Editorial feedback
nastasha-solomon ad8f2a4
Merge branch 'main' into alerting/experimental-setup
nastasha-solomon 483559e
Merge branch 'main' into alerting/experimental-setup
nastasha-solomon 903bd69
Merge branch 'main' into alerting/experimental-setup
nastasha-solomon 2d2ab40
Feedback from Christos
nastasha-solomon 378839f
Apply suggestions from code review
nastasha-solomon bf496ec
Apply suggestions from code review
nastasha-solomon 21a88e0
Merge branch 'main' into alerting/experimental-setup
nastasha-solomon 3f25a39
cleanup
nastasha-solomon 4d3608e
Apply suggestions from code review
nastasha-solomon 13d85ec
Apply suggestion from @nastasha-solomon
nastasha-solomon ae77e11
fix comments
nastasha-solomon 439934a
update anchors
nastasha-solomon 4180ee8
update folder name
nastasha-solomon 8db19db
Merge branch 'main' into alerting/experimental-setup
nastasha-solomon dfac96e
Hide experimental alerting get-started pages in TOC; update alerts.md…
nastasha-solomon 4324f8e
Merge remote-tracking branch 'origin/main' into alerting/experimental…
nastasha-solomon b5d7aa6
fix order in toc
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
18 changes: 18 additions & 0 deletions
18
explore-analyze/alerting/experimental-alerting-system/get-started.md
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,18 @@ | ||
| --- | ||
| navigation_title: Get started | ||
| applies_to: | ||
| stack: experimental 9.5+ | ||
| serverless: experimental | ||
| products: | ||
| - id: kibana | ||
| - id: cloud-serverless | ||
| description: "Get started with the experimental alerting system in Kibana: review requirements, enable the system, configure role access, and follow a tutorial to create a rule and observe the alert lifecycle." | ||
| --- | ||
|
|
||
| # Get started with the {{alerting-v2-system}} [get-started] | ||
|
|
||
| Use these guides to get the {{alerting-v2-system}} running in your space, set up role access for your team, and create your first rule. | ||
|
|
||
| - [Set up the {{alerting-v2-system}}](get-started/setup.md): Review requirements, enable the `alerting:v2:enabled` advanced setting, and confirm the system is accessible in your space. | ||
| - [Configure access](get-started/configure-access.md): Set up a role with the {{kib}} feature privileges needed to create rules, triage alerts, and query alert data. | ||
| - [Create your first rule](get-started/create-your-first-rule.md): A hands-on tutorial that walks you through loading sample data, creating a rule, and observing the alert lifecycle from breach through automatic recovery. |
138 changes: 138 additions & 0 deletions
138
...e-analyze/alerting/experimental-alerting-system/get-started/configure-access.md
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,138 @@ | ||
| --- | ||
| navigation_title: Configure access | ||
| applies_to: | ||
| stack: experimental 9.5+ | ||
| serverless: experimental | ||
| products: | ||
| - id: kibana | ||
| - id: cloud-serverless | ||
| description: "Privilege requirements for Kibana experimental alerting features: which Kibana feature privileges and Elasticsearch index privileges each role needs to manage rules, action policies, alerts, and query rule events and alert actions." | ||
| --- | ||
|
|
||
| # Configure access to the {{alerting-v2-system}} [access] | ||
|
|
||
| To use the {{alerting-v2-system}}, your role needs specific {{kib}} feature privileges and, if you're querying alerting data in Discover, {{es}} index privileges. [Create or update a role](/deploy-manage/users-roles/cluster-or-deployment-auth/kibana-role-management.md) and add the privileges that match the tasks your team performs. | ||
|
|
||
| This page is organized by user activity. Most privileges are set under the **Alerting** category in {{kib}} role management. Exceptions are noted in each section. | ||
|
|
||
| :::{note} | ||
| This page covers access to the {{alerting-v2-system}} features and data. Depending on how your rules and notifications are configured, your role might also need `read` index privileges on the indices their rules query and **Actions and Connectors: All** (under **Management**) to create or edit workflow connectors. Refer to [{{kib}} role management](/deploy-manage/users-roles/cluster-or-deployment-auth/kibana-role-management.md) for guidance on building roles that combine privileges across features. | ||
|
nastasha-solomon marked this conversation as resolved.
|
||
| ::: | ||
|
|
||
| ## Quick reference [alerting-quick-reference] | ||
|
|
||
| The following table shows the minimum privileges required for each activity. Higher privilege levels include the access shown here. Refer to the following sections for the full breakdown. | ||
|
|
||
| | To... | Minimum required | | ||
| |---|---| | ||
| | Author and manage rules | **Rules: All** (under **Alerting**) | | ||
| | Monitor rule execution | **Execution history: Read** (under **Alerting**) | | ||
| | Triage alert episodes | **Alerts: All** (under **Alerting**) | | ||
| | Configure notifications | **Action Policies: All** (under **Alerting**) + **Workflows: Read** (under **Analytics > Workflows**) | | ||
| | Query `.rule-events` and `.alert-actions` in Discover | **Discover: Read** (under **Analytics > Discover**) + **Alerts: Read** (Elasticsearch `read` access is bundled automatically) | | ||
| | Query `.kibana-event-log-*` in Discover | **Discover: Read** (under **Analytics > Discover**) + custom role with `read` index privilege on `.kibana-event-log-*` | | ||
|
|
||
| ## Author and monitor rules [alerting-authoring-monitoring-privileges] | ||
|
|
||
| These privileges control who can create rules and review their execution history. | ||
|
|
||
| ### Rules [alerting-manage-rules-privileges] | ||
|
|
||
| The **Rules** privilege controls who can create and manage rules. | ||
|
|
||
| | Level | What you can do | | ||
| |---|---| | ||
| | **All** | Create, edit, delete, enable, and turn off rules | | ||
| | **Read** | View rules and their configuration | | ||
|
|
||
| :::{note} | ||
| **Rules: All** also grants access to the **Alerts** menu in Discover, which routes rule creation to the {{alerting-v2-system}} rule form when the system is enabled in your space. | ||
| ::: | ||
|
|
||
| ### View rule execution history [alerting-execution-history-privileges] | ||
|
|
||
| The **Execution history** privilege controls who can view rule execution history. Execution history is read-only; both **All** and **Read** grant the same access. There is no write surface for execution history. | ||
|
|
||
| | Level | What you can do | | ||
| |---|---| | ||
| | **All** | View rule execution history | | ||
| | **Read** | View rule execution history | | ||
|
|
||
| ## Triage alerts [alerting-triage-privileges] | ||
|
|
||
| The **Alerts** privilege controls who can take triage actions on alert episodes. | ||
|
|
||
| | Level | What you can do | | ||
| |---|---| | ||
| | **All** | Acknowledge, snooze, assign, tag, activate, and deactivate alert episodes | | ||
| | **Read** | View alert episodes | | ||
|
|
||
| :::{note} | ||
| Granting **Alerts: All** or **Alerts: Read** also gives the role direct Elasticsearch `read` access to `.rule-events` and `.alert-actions`, scoped to that role's spaces. This is bundled into the privilege — no separate custom role or index privilege is needed to query these data streams in Discover. | ||
| ::: | ||
|
|
||
| ## Configure notifications [alerting-notifications-privileges] | ||
|
|
||
| These privileges control who can set up the action policies and workflows that route alert episode notifications. | ||
|
|
||
| ### Action policies [action-policy-management] | ||
|
|
||
| The **Action Policies** privilege controls who can manage the action policies that route alert episode notifications. | ||
|
|
||
| | Level | What you can do | | ||
| |---|---| | ||
| | **All** | Create, update, delete, snooze, and unsnooze action policies | | ||
| | **Read** | View action policies | | ||
|
|
||
| :::{note} | ||
| Having **Action Policies: All** does not include the ability to create or edit rules. Add **Rules: All** if rule management is also required. | ||
| ::: | ||
|
|
||
| ### Workflows [alerting-workflows-access] | ||
|
|
||
| Action policies route notifications through workflows. The **Workflows** privilege is set under **Analytics > Workflows** in {{kib}} role management. To create or manage action policies, your role also needs access to the workflows they reference. | ||
|
|
||
| | Level | What you can do | | ||
| |---|---| | ||
| | **All** | Create and edit workflows; view and select existing workflows in action policies | | ||
| | **Read** | View and select existing workflows in action policies | | ||
|
|
||
| ## Query rule output and episode data [alerting-data-investigation-privileges] | ||
|
nastasha-solomon marked this conversation as resolved.
|
||
|
|
||
| The {{alerting-v2-system}} writes rule output and episode data to three queryable data sources. To query them in Discover using {{esql}}, your role needs {{kib}} feature access and {{es}} index access. | ||
|
|
||
| ### {{kib}} feature access | ||
|
|
||
| Set Discover privileges under **Analytics > Discover** in {{kib}} role management. | ||
|
|
||
| | Level | What you can do | | ||
| |---|---| | ||
| | **All** | Run {{esql}} queries against rule events, alert actions, and execution history in Discover | | ||
| | **Read** | Run {{esql}} queries against rule events, alert actions, and execution history in Discover | | ||
|
|
||
| Both levels grant the same query access. There is no write surface for any of these data sources in Discover. | ||
|
|
||
| ### {{es}} index access | ||
|
nastasha-solomon marked this conversation as resolved.
|
||
|
|
||
| For `.rule-events` and `.alert-actions`, {{es}} `read` access is bundled into the **Alerts** {{kib}} privilege. For `.kibana-event-log-*`, a custom role is still required. | ||
|
|
||
| | Data source | What it stores | How to grant access | | ||
| |---|---|---| | ||
| | `.rule-events` | A record for every rule evaluation; one document per result row per run | Automatic with **Alerts: All** or **Alerts: Read**. If access is missing, grant `read` using a custom role as a fallback. | | ||
| | `.alert-actions` | User-triggered triage records (acknowledge, snooze, resolve, assign) and system-written dispatcher records. | Automatic with **Alerts: All** or **Alerts: Read**. If access is missing, grant `read` using a custom role as a fallback. | | ||
| | `.kibana-event-log-*` | Action policy dispatch outcomes written by the dispatcher: `dispatched`, `throttled`, and `unmatched` | Custom role with `read` index privilege. Not covered by the automatic grant. | | ||
|
|
||
| <!-- TODO: When PR #6527 merges, update the `.alert-actions` row above ("What it stores" column) to add a link to the field reference. Full updated cell: | ||
| "User-triggered triage records (acknowledge, snooze, resolve, assign) and system-written dispatcher records. For all `action_type` values, refer to the [alert data stream field reference](../alerts/field-reference.md)." --> | ||
|
|
||
| ## Next steps [alerting-access-next-steps] | ||
|
|
||
| With access configured, you're ready to [create your first rule](create-your-first-rule.md). | ||
|
|
||
| <!-- TODO: When PRs #6523 (rules) and #6525 (workflows/notifications) are merged, replace the sentence | ||
| above with the bulleted list below (delete the prose line, uncomment the list). | ||
|
|
||
| - **[Create a rule](../rules/create-a-rule.md):** Write the {{esql}} query that defines what to detect, choose Signal or Alert mode, and configure grouping and thresholds. ← PR #6523 | ||
| - **[Set up workflows](../notifications-actions.md):** Configure the automation objects that deliver notifications — email, Slack, webhook, and so on. ← PR #6525 | ||
| - **[Create action policies](../action-policies/create-configure-action-policy.md):** Define who gets notified, how often, and under what conditions. ← PR #6525 | ||
| --> | ||
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.