From 96cd34790e2e67bf04523d1b3ad39fc21ecf1a6f Mon Sep 17 00:00:00 2001 From: vagimeli Date: Thu, 4 May 2023 20:51:49 -0600 Subject: [PATCH 01/44] Add documentation for alerting dashboards and visualizations Signed-off-by: vagimeli --- .../alerting/dashboards-alerting.md | 104 ++++++++++++++++++ 1 file changed, 104 insertions(+) create mode 100644 _observing-your-data/alerting/dashboards-alerting.md diff --git a/_observing-your-data/alerting/dashboards-alerting.md b/_observing-your-data/alerting/dashboards-alerting.md new file mode 100644 index 0000000000..0c7768bf5b --- /dev/null +++ b/_observing-your-data/alerting/dashboards-alerting.md @@ -0,0 +1,104 @@ +--- +layout: default +title: Creating alerts with Dashboard +parent: Alerting +nav_order: 50 +--- + +# Creating alerts with Dashboard +Introduced 2.8 +{: .label .label-purple } + +Use the **Dashboard** app to set up alerts and display visualizations from within the app instead of jumping between the app and the [alerting plugin]({{site.url}}{{site.baseurl}}/observing-your-data/alerting/index/) page. The Dashboard app gives you one place to: + +- Set up, add, and adjust rules and conditions that trigger alerts and notifications. +- Create visualizations to help you quickly see trends and patterns or identify and address issues. +- Build dashboards to stay on top of important metrics and data points in real time. +- Monitor your alerts in one place with at-a-glance dashboards. + +Getting started with alerting in Dashboard is straightforward. Watch this video for a quick overview of some of the tasks we'll perform in this tutorial. + + + +## Prerequisites + +- If you don't already have OpenSearch and OpenSearch Dashboards 2.8 or later, [download or upgrade OpenSearch](https://opensearch.org/docs/latest/install-and-configure/install-opensearch/index/) to get started. +- . +- . + +## Visualization requirements + +Certain options are available for alerting visualizations. Consider the following requirements when building your dashboards and visualizations: + + + +## Configuring admin settings + + Access to alerting dashboards and visualizations is controlled by OpenSearch and OpenSearch Dashboards privileges. You can manage your settings in **Stack Management**. Access is enabled by default and appears as a feature in the **Stack Management > Advanced Settings > Visualizations** window as shown in the following image. If the setting is disabled, it does not appear in this window. + +If you are an administrator, you can disable the settings at the cluster level through the `opensearch-dashboards.yml` configuration file, for example: + +```bash + +``` + +## Creating alerting monitors + +By default, when you begin to create the alert monitor workflow with 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 drop down, to define the metrics to monitor, set thresholds, customize triggers that automate workflows, and generate actions when conditions are met. + +To create alerts and display alerting visualizations on a dashboard, follow these steps: + +1. Open OpenSearch Dashboards in your web browser. If you are running Dashboards locally, go to `http://localhost:5601/`. +2. From the main menu, select **Dashboard**. + + + + + + +3. From ****, select the **** sample dataset. You will see a pre-populated dashboard with line chart visualizations. +4. Select the ellipsis icon from the **** visualization pane, and then from the **Options** flyout, choose **Alerting** > **Add alerting monitor**. +5. Select **Create new monitor**. +6. From the **Add alerting monitor** window, define the metrics and set the thresholds under **Monitor details** and **Triggers**. +7. Under **Monitor details**, select