Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions docset.yml
Original file line number Diff line number Diff line change
Expand Up @@ -125,6 +125,8 @@ subs:
maint-windows-cap: "Maintenance windows"
alerting-v2: "experimental alerting features"
alerting-v2-cap: "Experimental alerting features"
alerting-v2-system: "experimental alerting system"
alerting-v2-system-cap: "Experimental alerting system"
custom-roles-app: "Custom Roles"
data-source: "data view"
data-sources: "data views"
Expand Down

This file was deleted.

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: "Enable the experimental alerting system in Kibana, configure role access, and create your first rule."
---

# Get started with the {{alerting-v2-system}} [alerting-v2-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.

- [Turn on the {{alerting-v2-system-cap}}](get-started/setup.md): 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 and {{es}} index privileges needed to create rules 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 watching the alert lifecycle play out from breach to recovery.
Original file line number Diff line number Diff line change
@@ -0,0 +1,124 @@
---
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}} [alerting-privileges]

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.
:::

## 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 |

Check notice on line 26 in explore-analyze/alerting/kibana-alerting-experimental/get-started/configure-access.md

View workflow job for this annotation

GitHub Actions / build / vale

Elastic.Ellipses: In general, don't use an ellipsis.
|---|---|
| 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 and episode data in Discover | **Discover: Read** (under **Analytics > Discover**) + `read` index privilege on the relevant data stream |

## 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 |

## Triaging 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 |

## 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 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]

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

Each data source requires a separate `read` index privilege:

| Data source | What it stores | Required privilege |
|---|---|---|
| `.rule-events` | A record for every rule evaluation — one document per result row per run | `read` |
| `.alert-actions` | Episode action records: acknowledge, snooze, resolve, assign, and other triage operations | `read` |
| `.kibana-event-log-*` | Action policy dispatch outcomes written by the dispatcher: `dispatched`, `throttled`, and `unmatched` | `read` |

Because `.rule-events` and `.alert-actions` are hidden system data streams, request access through a custom role with the appropriate index privileges.

<!-- TODO: Uncomment when PR #6527 (alerts) is merged, and add as a link in the note under the Rules section:
For step-by-step instructions, refer to [Create a rule from Discover](../alerts/query-alerts-and-signals-in-discover.md).
-->
Loading
Loading