Skip to content
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

[DOC] Add documentation for alerting dashboards and visualizations #4024

Merged
merged 44 commits into from
Jul 17, 2023
Merged
Show file tree
Hide file tree
Changes from 10 commits
Commits
Show all changes
44 commits
Select commit Hold shift + click to select a range
96cd347
Add documentation for alerting dashboards and visualizations
vagimeli May 5, 2023
9f5749f
Address tech reveiw feedback
vagimeli May 5, 2023
e3c7d92
Revisions
vagimeli May 9, 2023
81144b5
editing
vagimeli May 9, 2023
2465166
writing
vagimeli May 10, 2023
c25800f
Update tutorial to current UI
vagimeli May 16, 2023
55aa0f0
rewriting
vagimeli May 18, 2023
7375d71
Revisions
vagimeli May 18, 2023
cdb204a
Revisions
vagimeli May 18, 2023
9a5a4c0
Update dashboards-alerting.md
vagimeli May 18, 2023
cfe60cf
Address tech review input
vagimeli Jun 9, 2023
fdce23c
Update dashboards-alerting.md
vagimeli Jun 9, 2023
16940af
Update dashboards-alerting.md
vagimeli Jul 13, 2023
2c03896
Update dashboards-alerting.md
vagimeli Jul 13, 2023
a8b8d7b
Update dashboards-alerting.md
vagimeli Jul 13, 2023
c45d214
Update dashboards-alerting.md
vagimeli Jul 14, 2023
ce3b78b
Update _observing-your-data/alerting/dashboards-alerting.md
vagimeli Jul 14, 2023
c578b56
Update _observing-your-data/alerting/dashboards-alerting.md
vagimeli Jul 14, 2023
e842826
Update dashboards-alerting.md
vagimeli Jul 14, 2023
91df298
Update dashboards-alerting.md
vagimeli Jul 14, 2023
bd0ba54
Update dashboards-alerting.md
vagimeli Jul 14, 2023
c81e76e
Update dashboards-alerting.md
vagimeli Jul 14, 2023
137136d
Update _observing-your-data/alerting/dashboards-alerting.md
vagimeli Jul 14, 2023
1495fb2
Update dashboards-alerting.md
vagimeli Jul 14, 2023
fbb70ce
Update _observing-your-data/alerting/dashboards-alerting.md
vagimeli Jul 14, 2023
08add2f
Update _observing-your-data/alerting/dashboards-alerting.md
vagimeli Jul 14, 2023
826b5bc
Update _observing-your-data/alerting/dashboards-alerting.md
vagimeli Jul 14, 2023
121a115
Update _observing-your-data/alerting/dashboards-alerting.md
vagimeli Jul 14, 2023
06dfe97
Update _observing-your-data/alerting/dashboards-alerting.md
vagimeli Jul 14, 2023
c6651ed
Update _observing-your-data/alerting/dashboards-alerting.md
vagimeli Jul 14, 2023
ea4d0dc
Update dashboards-alerting.md
vagimeli Jul 14, 2023
67b1cc5
Update _observing-your-data/alerting/dashboards-alerting.md
vagimeli Jul 14, 2023
3e34e7c
Update _observing-your-data/alerting/dashboards-alerting.md
vagimeli Jul 14, 2023
b52de66
Update _observing-your-data/alerting/dashboards-alerting.md
vagimeli Jul 14, 2023
388d1e1
Update dashboards-alerting.md
vagimeli Jul 14, 2023
c9c20e8
Update _observing-your-data/alerting/dashboards-alerting.md
vagimeli Jul 14, 2023
99d665c
Update _observing-your-data/alerting/dashboards-alerting.md
vagimeli Jul 14, 2023
3deb6f5
Update _observing-your-data/alerting/dashboards-alerting.md
vagimeli Jul 14, 2023
3df7a75
Update dashboards-alerting.md
vagimeli Jul 14, 2023
28bee1b
Update _observing-your-data/alerting/dashboards-alerting.md
vagimeli Jul 14, 2023
9bf8e09
Update _observing-your-data/alerting/dashboards-alerting.md
vagimeli Jul 14, 2023
4861309
Update _observing-your-data/alerting/dashboards-alerting.md
vagimeli Jul 14, 2023
aca8822
Update dashboards-alerting.md
vagimeli Jul 14, 2023
55910cb
add updated alerting dashboard image
vagimeli Jul 17, 2023
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
92 changes: 92 additions & 0 deletions _observing-your-data/alerting/dashboards-alerting.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,92 @@
---
layout: default
title: Integrating alerts with Dashboard
parent: Alerting
nav_order: 50
---

# Integrating alerts with Dashboard
vagimeli marked this conversation as resolved.
Show resolved Hide resolved
Introduced 2.8
vagimeli marked this conversation as resolved.
Show resolved Hide resolved
{: .label .label-purple }

Create, manage, and take action on your alerts in a single, consolidated view and identify and resolve issues quickly. Use the **Dashboard** app to:

- Set up, add, and adjust rules and conditions that trigger alerts and notifications.
- Create graphs that show trends and patterns and build intuitive dashboards to stay on top of important metrics and data points in real time.
vagimeli marked this conversation as resolved.
Show resolved Hide resolved
- Monitor your alerts in one place with at-a-glance views.

<img src="{{site.url}}{{site.baseurl}}/images/dashboards/alerting-viz.png" alt="Example alerting visualization" width="800" height="800">
vagimeli marked this conversation as resolved.
Show resolved Hide resolved
vagimeli marked this conversation as resolved.
Show resolved Hide resolved

## Getting started

Before getting started, you must have:

- Installed OpenSearch and OpenSearch Dashboards version 2.8 or later. See [Installing OpenSearch]({{site.url}}{{site.baseurl}}/install-and-configure/install-opensearch/index/).
- Installed Alerting and Notifications Dashboards plugins. See [Managing OpenSearch Dashboards plugins]({{site.url}}{{site.baseurl}}/install-and-configure/install-dashboards/plugins/) to get started.
vagimeli marked this conversation as resolved.
Show resolved Hide resolved

## Configuring admin settings

You can only access, create, or manage alerts for resources for which you have permissions. Access to alerting dashboards and visualizations is controlled by OpenSearch and OpenSearch Dashboards privileges, and you can manage the settings in **Stack Management**. Access is enabled by default and appears as a feature in the **Stack Management** > **Advanced Settings** > **Visualizations** window. If the setting is disabled, it does not appear in this window. The setting is disabled at the cluster level through the `opensearch-dashboards.yml` file.
vagimeli marked this conversation as resolved.
Show resolved Hide resolved

## General requirements for alerting visualizations

Alerting visualizations are displayed as time-series charts that give you a snapshot of the alert, alert status, last updated time, and reason for the alert. You can show up to 10 metrics on your chart, and each series can be shown as a line in the chart.
vagimeli marked this conversation as resolved.
Show resolved Hide resolved

Keep in mind the following requirements when setting up or creating alerting visualizations:

- Must be a [Vizlib line chart](https://community.vizlib.com/support/solutions/articles/35000107262-vizlib-line-chart-introduction)
vagimeli marked this conversation as resolved.
Show resolved Hide resolved
vagimeli marked this conversation as resolved.
Show resolved Hide resolved
- Must contain one Y-axis metric aggregation
vagimeli marked this conversation as resolved.
Show resolved Hide resolved
- Must not have non-Y-axis metric aggregation types
vagimeli marked this conversation as resolved.
Show resolved Hide resolved
- Must use date histogram aggregation type for the X-axis bucket
vagimeli marked this conversation as resolved.
Show resolved Hide resolved
- Must have X-axis on the bottom
vagimeli marked this conversation as resolved.
Show resolved Hide resolved
- Must define one X-axis aggregation bucket
- Must have a valid time-based X-axis

## Creating alerting monitors with Dashboard

By default, when you begin to create the alert monitor workflow using the Dashboard app, you are presented with a menu-driven interface. This interface provides a range of options, displayed in full screen, pop-up, pull-down, or dropdown, to define the metrics to monitor, set thresholds, customize triggers that automate workflows, and generate actions when conditions are met. Currently, you can create query-level monitors only.
vagimeli marked this conversation as resolved.
Show resolved Hide resolved

#### To create an alerting monitor

1. Choose **Dashboard** from the OpenSearch Dashboards main menu.
2. From the **Dashboards** window, select **Create** and then choose **Dashboard**.
3. Select **Add an existing**, then select the appropriate alerting visualization from the **Add panels** list. The visualization is added to the dashboard.
4. From the visualization panel, choose the ellipsis icon ({::nomarkdown}<img src="{{site.url}}{{site.baseurl}}/images/ellipsis-icon.png" class="inline-icon" alt="ellipsis icon"/>{:/}).
5. From the **Options** menu, select **Add alerting monitor**.
6. Input information for **Monitor details** and **Triggers**
vagimeli marked this conversation as resolved.
Show resolved Hide resolved
7. Choose **Create monitor**. The monitor is added to the visualization.

An example of the create monitor steps is shown in the following screenshot.
vagimeli marked this conversation as resolved.
Show resolved Hide resolved

<img src="{{site.url}}{{site.baseurl}}/images/dashboards/create-monitor-menu.png" alt="Create monitor interface" width="400" height="400">

## Associating monitors

You can associate existing monitors with a visualization using the Dashboard app instead of the plugin page, giving you a single interface to add, view, and edit monitor data.
vagimeli marked this conversation as resolved.
Show resolved Hide resolved

#### To associate a monitor
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This heading reads a bit oddly because it's used as a procedure heading above but as a section heading here (no sentence follows it in the preceding instance).


Continuing with the alerting visualization and dashboard created in the preceding tutorial, associate an existing monitor with a visualization by following these steps.
vagimeli marked this conversation as resolved.
Show resolved Hide resolved

1. From the visualization panel, choose the ellipsis icon ({::nomarkdown}<img src="{{site.url}}{{site.baseurl}}/images/ellipsis-icon.png" class="inline-icon" alt="ellipsis icon"/>{:/}).
2. Select **Associated monitors**.
3. From the **Select monitor to associate** dropdown menu, select the monitor. Only eligible monitors are listed in the dropdown menu.
4. View the monitor's basic information. To view comprehensive details, select **View monitor page** to open the Alerting plugin page.
5. Select **Associate monitor**. An existing monitor is associated to the visualization.
vagimeli marked this conversation as resolved.
Show resolved Hide resolved

## Exploring alerting monitor details

Once you've created or associated alerting monitors, verify the monitor is generating the alerts and explore alert details by following these steps:
vagimeli marked this conversation as resolved.
Show resolved Hide resolved

1. Open the alerting dashboard. Alerts are indicated on the visualization with a triangle icon ({::nomarkdown}<img src="{{site.url}}{{site.baseurl}}/images/dashboards/triangle-icon.png" class="inline-icon" alt="triangle icon"/>{:/}).
2. Hover over a triangle to view high-level data, such as number of alerts. To investigate alert details, select the triangle icon ({::nomarkdown}<img src="{{site.url}}{{site.baseurl}}/images/dashboards/triangle-icon.png" class="inline-icon" alt="triangle icon"/>{:/}) to open a flyout with more detailed monitor information. Alternatively, select the ellipsis icon ({::nomarkdown}<img src="{{site.url}}{{site.baseurl}}/images/ellipsis-icon.png" class="inline-icon" alt="ellipsis icon"/>{:/}) in the visualization panel and choose **View events**.
vagimeli marked this conversation as resolved.
Show resolved Hide resolved
3. Select the ellipsis icon ({::nomarkdown}<img src="{{site.url}}{{site.baseurl}}/images/ellipsis-icon.png" class="inline-icon" alt="ellipsis icon"/>{:/}), then **Alerting** > **Associated monitors**.
4. Choose an alerting monitor from the list. Information such as history, alerts, and associated visualizations are shown within the visualization panel.
vagimeli marked this conversation as resolved.
Show resolved Hide resolved
5. Explore unlinking or editing a monitor.
vagimeli marked this conversation as resolved.
Show resolved Hide resolved
1. Unlink a monitor from the visualization by selecting the link icon ({::nomarkdown}<img src="{{site.url}}{{site.baseurl}}/images/dashboards/link-icon.png" class="inline-icon" alt="link icon"/>{:/}) under **Actions**. This unlinks the monitor from the visualization only; it does not delete the monitor.
vagimeli marked this conversation as resolved.
Show resolved Hide resolved
2. Edit the monitor's metrics by selecting the edit icon ({::nomarkdown}<img src="{{site.url}}{{site.baseurl}}/images/dashboards/edit-icon.png" class="inline-icon" alt="edit icon"/>{:/}).

## Next steps

- [Learn more about Dashboard](https://opensearch.org/docs/latest/dashboards/dashboard/index/)
vagimeli marked this conversation as resolved.
Show resolved Hide resolved
- [Learn more about alerting](https://opensearch.org/docs/latest/observing-your-data/alerting/index/)
vagimeli marked this conversation as resolved.
Show resolved Hide resolved
Binary file added images/dashboards/alerting-viz.png
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Will provide another screen shot as the tool tip does not contain the timestamp actually.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@lezzago Please provide screenshot or link to current testing environment and I'll grab one. Thanks :)

vagimeli marked this conversation as resolved.
Show resolved Hide resolved
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/dashboards/create-monitor-menu.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/dashboards/edit-icon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/dashboards/link-icon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/dashboards/triangle-icon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/ellipsis-icon.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.