Skip to content

Commit 4ac456d

Browse files
[DOCS] Response ops 8.19 updates (#229547)
## Summary Updates the documentation for responseOps dashboards to reflect two new features. 9.1 version of these docs updates are in elastic/docs-content#2165 and elastic/docs-content#2139 ### Checklist Check the PR satisfies following conditions. Reviewers should verify this PR satisfies this list as well. - [ ] Any text added follows [EUI's writing guidelines](https://elastic.github.io/eui/#/guidelines/writing), uses sentence case text and includes [i18n support](https://github.com/elastic/kibana/blob/main/src/platform/packages/shared/kbn-i18n/README.md) - [ ] [Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html) was added for features that require explanation or tutorials - [ ] [Unit or functional tests](https://www.elastic.co/guide/en/kibana/master/development-tests.html) were updated or added to match the most common scenarios - [ ] If a plugin configuration key changed, check if it needs to be allowlisted in the cloud and added to the [docker list](https://github.com/elastic/kibana/blob/main/src/dev/build/tasks/os_packages/docker_generator/resources/base/bin/kibana-docker) - [ ] This was checked for breaking HTTP API changes, and any breaking changes have been approved by the breaking-change committee. The `release_note:breaking` label should be applied in these situations. - [ ] [Flaky Test Runner](https://ci-stats.kibana.dev/trigger_flaky_test_runner/1) was used on any tests changed - [ ] The PR description includes the appropriate Release Notes section, and the correct `release_note:*` label is applied per the [guidelines](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process) - [ ] Review the [backport guidelines](https://docs.google.com/document/d/1VyN5k91e5OVumlc0Gb9RPa3h1ewuPE705nRtioPiTvY/edit?usp=sharing) and apply applicable `backport:*` labels. --------- Co-authored-by: Nastasha Solomon <[email protected]>
1 parent 8c83f53 commit 4ac456d

File tree

2 files changed

+63
-0
lines changed

2 files changed

+63
-0
lines changed
Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
[[alert-panels]]
2+
= Alert panels
3+
4+
To view alerts in a dashboard, add *Alerts* panels that show selected alerts. Each panel can display either *Observability* or *Security* alerts, filtered by the rule tags and rule types you select.
5+
6+
[[create-alerts-panel]]
7+
[discrete]
8+
== Create an alerts panel
9+
10+
. From your dashboard, select *Add panel*.
11+
. In the *Add panel* flyout, select *Alerts*. The configuration flyout appears.
12+
. ({stack} deployments only) Under *Solution*, select either *Observability* or *Security* to specify the type of alerts you want to display.
13+
. Under *Filter by*, select either *Rule tags* or *Rule types*.
14+
. (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.
15+
. Click *Save*. Your panel appears on the dashboard.
16+
17+
[[alert-panel-actions]]
18+
[discrete]
19+
== Take action on alerts
20+
21+
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:
22+
23+
* *View rule details*: Open the details page for the rule that created the alert.
24+
* *View alert details*: Open the alert details flyout.
25+
* (*Active* rules only) *Mark as untracked*: Change the alert's status from *Active* to *Untracked*.
26+
* (*Active* rules only) *Mute*: Mute alerts from the associated rule.
27+
28+
[[edit-alerts-panel]]
29+
[discrete]
30+
== Edit an alerts panel
31+
32+
To edit an existing alerts panel, hover over the panel. Three buttons appear:
33+
34+
* *Edit* (pencil): Update which alerts appear in the panel.
35+
* *Settings* (gear): Update the panel's title or description, or add a custom time range.
36+
* *More actions* (three boxes): Duplicate, maximize, copy to another dashboard, or remove the panel.

docs/user/dashboard/create-visualizations.asciidoc

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,9 @@ Use one of the editors to create visualizations of your data. Each editor offers
2020
| <<maps,Maps>>
2121
| Create beautiful displays of your geographical data
2222

23+
| <<alert-panels,Alerts>>
24+
| View Observability or Security alerts in your dashboard
25+
2326
| <<field-statistics-dashboard,Field statistics>>
2427
| Add a field statistics view of your data to your dashboards
2528

@@ -240,6 +243,29 @@ image::images/esql-visualization-customization-options.png[Appearance customizat
240243

241244
. Return to the previous menu, then **Apply and close** the configuration to save your changes.
242245

246+
[[create-alert-from-esql-viz]]
247+
[float]
248+
== Create an alert from your {esql} visualization
249+
250+
Once you've created an {esql} panel, you can create an {es} threshold rule directly from the visualization panel based on the data it displays. When you do this, the rule query is automatically generated and either describes the data and sets a specific threshold, or describes the data without setting a specific threshold.
251+
252+
[NOTE]
253+
====
254+
{elastic-sec} rule types are not supported.
255+
====
256+
257+
To create a rule with the threshold pre-specified:
258+
259+
* Right-click a data point in the visualization and click *Add alert rule*. This opens the *Create rule* flyout. The generated query will define a threshold that corresponds to the data point you selected.
260+
* {kib-ref}/rule-type-es-query.html[Configure] your {es} rule.
261+
262+
To create a rule without the threshold pre-specified:
263+
264+
* Open the *More actions* (three dots) menu in the upper right of the panel and select *Add alert rule*. This opens the *Create rule* flyout. The generated query will define a threshold that corresponds to the data point you selected.
265+
* {kib-ref}/rule-type-es-query.html[Configure] your {es} rule.
266+
267+
include::alerts-panel.asciidoc[][leveloffset=-1]
268+
243269
[[maps-visualizations]]
244270
== Maps
245271

@@ -328,6 +354,7 @@ When importing a dashboard with an image panel, and the image file is unavailabl
328354

329355
include::links-panel.asciidoc[leveloffset=-1]
330356

357+
331358
[[legacy-editors]]
332359
== Legacy editors
333360

0 commit comments

Comments
 (0)