Skip to content

Commit 7a05cfe

Browse files
Creates alerts panel dashboard docs (#2139)
Fixes #1712 by adding a new panel type to the custom dashboard documentation. Alerts panels show a simplified version of the Alerts table from Observability or Security. Refer to the preview links in the comment below to see how the pages look rendered. --------- Co-authored-by: florent-leborgne <florent.leborgne@elastic.co>
1 parent fd55e0e commit 7a05cfe

File tree

4 files changed

+44
-0
lines changed

4 files changed

+44
-0
lines changed
Loading

explore-analyze/toc.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -274,6 +274,7 @@ toc:
274274
- file: visualize/text-panels.md
275275
- file: visualize/image-panels.md
276276
- file: visualize/link-panels.md
277+
- file: visualize/alert-panels.md
277278
- file: visualize/canvas.md
278279
children:
279280
- file: visualize/canvas/edit-workpads.md

explore-analyze/visualize.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@ $$$panels-editors$$$
2121
| Visualizations | [Lens](visualize/lens.md) | Create powerful [charts](visualize/supported-chart-types.md) in {{kib}}. This is the default editor. |
2222
| | [ES&#124;QL](/explore-analyze/query-filter/languages/esql-kibana.md) | Create visualizations from ES&#124;QL queries |
2323
| | [Maps](visualize/maps.md) | Create beautiful displays of your geographical data |
24+
| | [Alerts](visualize/alert-panels.md) | View Observability or Security alerts in your dashboard |
2425
| | [Field statistics](visualize/field-statistics.md) | Add a field statistics view of your data to your dashboards |
2526
| | [Custom visualizations](visualize/custom-visualizations-with-vega.md) | Use Vega to create new types of visualizations |
2627
| | | |
Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
---
2+
applies_to:
3+
stack: ga 9.1
4+
serverless: ga
5+
products:
6+
- id: kibana
7+
---
8+
9+
# Alert panels
10+
11+
To view alerts in a dashboard, add **Alerts** panels that show selected alerts. Each panel can display either **Observability** or **Security** alerts with the rule tags and rule types that you select.
12+
13+
## Create an alerts panel
14+
15+
1. From your dashboard, select **Add panel**.
16+
2. In the **Add panel** flyout, select **Alerts**. The configuration flyout appears.
17+
3. ({{stack}} deployments only) Under **Solution**, select either **Observability** or **Security** to specify the type of alerts you want to display.
18+
4. Under **Filter by** select either **Rule tags** or **Rule types**.
19+
5. (Optional) To use both types of filters, first define one filter, then use the boolean **+ OR** or **+ AND** options that appear to define the second filter.
20+
5. Click **Save**. Your panel appears on the dashboard.
21+
22+
:::{image} /explore-analyze/images/dashboards-alert-panel.png
23+
:alt: An alerts panel on a dashboard
24+
:screenshot:
25+
:::
26+
27+
## Take action on alerts
28+
29+
There are several actions you can take on alerts in the alerts panel. Under **Actions**, click the three dots next to an alert to open a menu with the following options:
30+
31+
- **View rule details**: Open the details page for the rule that created the alert.
32+
- **View alert details**: Open the alert details flyout.
33+
- (**Active** rules only) **Mark as untracked**: Change the alert's status from **Active** to **Untracked**.
34+
- (**Active** rules only) **Mute**: Mute alerts from the associated rule.
35+
36+
## Edit an alerts panel
37+
38+
To edit an existing alerts panel, hover over the panel. Three buttons appear:
39+
40+
- **Edit** {icon}`pencil`: Update which alerts appear in the panel.
41+
- **Settings** {icon}`gear`: Update the panel's title or description, or add a custom time range.
42+
- **More actions** {icon}`boxes_vertical`: Duplicate, maximize, copy to another dashboard, or remove the panel.

0 commit comments

Comments
 (0)