From b34b0fb42855cd484cd44111a574e4969934ce3f Mon Sep 17 00:00:00 2001 From: Scott Anderson Date: Wed, 8 Apr 2020 16:22:04 -0600 Subject: [PATCH] updated alerting guides with new nav workflow --- content/v2.0/monitor-alert/checks/create.md | 5 +-- content/v2.0/monitor-alert/checks/delete.md | 6 +-- content/v2.0/monitor-alert/checks/update.md | 18 ++++----- content/v2.0/monitor-alert/checks/view.md | 20 +++++----- .../notification-endpoints/create.md | 11 +++--- .../notification-endpoints/delete.md | 8 ++-- .../notification-endpoints/update.md | 37 ++++++++++--------- .../notification-endpoints/view.md | 28 +++++++++----- .../notification-rules/create.md | 20 +++++----- .../notification-rules/delete.md | 7 ++-- .../notification-rules/update.md | 29 +++++++-------- .../monitor-alert/notification-rules/view.md | 25 +++++++------ 12 files changed, 114 insertions(+), 100 deletions(-) diff --git a/content/v2.0/monitor-alert/checks/create.md b/content/v2.0/monitor-alert/checks/create.md index 23c546d87..c1cfe65c3 100644 --- a/content/v2.0/monitor-alert/checks/create.md +++ b/content/v2.0/monitor-alert/checks/create.md @@ -43,12 +43,11 @@ A deadman check assigns a status to data when a series or group doesn't report in a specified amount of time. ## Create a check in the InfluxDB UI -1. Click **Monitoring & Alerting** in the sidebar in the InfluxDB UI. +1. In the navigation menu on the left, select **Alerts**. {{< nav-icon "alerts" >}} -2. In the top right corner of the **Checks** column, click **{{< icon "plus" >}} Create** - and select the [type of check](#check-types) to create. +2. Click **{{< icon "plus" >}} Create** and select the [type of check](#check-types) to create. 3. Click **Name this check** in the top left corner and provide a unique name for the check. #### Configure the check query diff --git a/content/v2.0/monitor-alert/checks/delete.md b/content/v2.0/monitor-alert/checks/delete.md index 8e884679f..4e35290ff 100644 --- a/content/v2.0/monitor-alert/checks/delete.md +++ b/content/v2.0/monitor-alert/checks/delete.md @@ -18,12 +18,12 @@ If you no longer need a check, use the InfluxDB user interface (UI) to delete it Deleting a check cannot be undone. {{% /warn %}} -1. Click **Monitoring & Alerting** in the sidebar. +1. In the navigation menu on the left, select **Alerts**. {{< nav-icon "alerts" >}} -2. In the **Checks** column, hover over the check you want to delete, click the - **{{< icon "delete" >}}** icon, then **Delete**. +2. Hover over the check you want to delete, click the **{{< icon "delete" >}}** + icon, and then **Delete**. After a check is deleted, all statuses generated by the check remain in the `_monitoring` bucket until the retention period for the bucket expires. diff --git a/content/v2.0/monitor-alert/checks/update.md b/content/v2.0/monitor-alert/checks/update.md index d2c9af61c..c2effc8ac 100644 --- a/content/v2.0/monitor-alert/checks/update.md +++ b/content/v2.0/monitor-alert/checks/update.md @@ -21,37 +21,35 @@ Common updates include: - [Add or update a check description](#add-or-update-a-check-description) - [Add a label to a check](#add-a-label-to-a-check) -To update checks, click **Monitoring & Alerting** in the InfluxDB UI sidebar. +To update checks, select **Alerts** in the navigation menu on the left. {{< nav-icon "alerts" >}} ## Update check queries and logic -1. In the **Checks** column, click the name of the check you want to update. - The check builder appears. -2. To edit the check query, click **1. Query** at the top of the check builder window. -3. To edit the check logic, click **2. Check** at the top of the check builder window. +1. Click the name of the check you want to update. The check builder appears. +2. To edit the check query, click **1. Define Query** at the top of the check builder window. +3. To edit the check logic, click **2. Configure Check** at the top of the check builder window. _For details about using the check builder, see [Create checks](/v2.0/monitor-alert/checks/create/)._ ## Enable or disable a check -In the **Checks** column, click the {{< icon "toggle" >}} toggle next to a check -to enable or disable it. +Click the {{< icon "toggle" >}} toggle next to a check to enable or disable it. ## Rename a check -1. In the **Checks** column, hover over the name of the check you want to update. +1. Hover over the name of the check you want to update. 2. Click the **{{< icon "edit" >}}** icon that appears next to the check name. 2. Enter a new name and click out of the name field or press enter to save. _You can also rename a check in the [check builder](#update-check-queries-and-logic)._ ## Add or update a check description -1. In the **Checks** column, hover over the check description you want to update. +1. Hover over the check description you want to update. 2. Click the **{{< icon "edit" >}}** icon that appears next to the description. 2. Enter a new description and click out of the name field or press enter to save. ## Add a label to a check -1. In the **Checks** column, click **Add a label** next to the check you want to add a label to. +1. Click **Add a label** next to the check you want to add a label to. The **Add Labels** box opens. 2. To add an existing label, select the label from the list. 3. To create and add a new label: diff --git a/content/v2.0/monitor-alert/checks/view.md b/content/v2.0/monitor-alert/checks/view.md index a41f90713..3c8412d4b 100644 --- a/content/v2.0/monitor-alert/checks/view.md +++ b/content/v2.0/monitor-alert/checks/view.md @@ -19,25 +19,25 @@ View check details and statuses and notifications generated by checks in the Inf - [View statuses generated by a check](#view-statuses-generated-by-a-check) - [View notifications triggered by a check](#view-notifications-triggered-by-a-check) -To view checks, click **Monitoring & Alerting** in the InfluxDB UI sidebar. +To view checks, click **Alerts** in navigation menu on the left. {{< nav-icon "alerts" >}} ## View a list of all checks -The **Checks** column on the Monitoring & Alerting landing page displays all existing checks. +The **Checks** section of the Alerts landing page displays all existing checks. ## View check details -In the **Checks** column, click the name of the check you want to view. +Click the name of the check you want to view. The check builder appears. Here you can view the check query and logic. ## View statuses generated by a check -1. In the **Checks** column, hover over the check, click the **{{< icon "view" >}}** - icon, then **View History**. - The Statuses History page displays statuses generated by the selected check. +1. Hover over the check and click the **{{< icon "view" >}}** icon. +2. Click **View History**. + The Statuses History page displays statuses generated by the selected check. ## View notifications triggered by a check -1. In the **Checks** column, hover over the check, click the **{{< icon "view" >}}** - icon, then **View History**. -2. In the top left corner, click **Notifications**. - The Notifications History page displays notifications initiated by the selected check. +1. Hover over the check, click the **{{< icon "view" >}}** + icon, then **View History**. +2. In the top left corner, click **Notifications**. + The Notifications History page displays notifications initiated by the selected check. diff --git a/content/v2.0/monitor-alert/notification-endpoints/create.md b/content/v2.0/monitor-alert/notification-endpoints/create.md index 736b543d1..989aee77e 100644 --- a/content/v2.0/monitor-alert/notification-endpoints/create.md +++ b/content/v2.0/monitor-alert/notification-endpoints/create.md @@ -16,12 +16,13 @@ To send notifications about changes in your data, start by creating a notificati ## Create a notification endpoint in the UI -1. Select the **Monitoring and Alerting** icon from the sidebar. +1. In the navigation menu on the left, select **Alerts**. {{< nav-icon "alerts" >}} -2. Next to **Notification Endpoints**, click **Create**. -3. From the **Destination** drop-down list, select a destination endpoint to send notifications. +2. Select **Notification Endpoints** near to top of the page. +3. Click **{{< icon "plus" >}} Create**. +4. From the **Destination** drop-down list, select a destination endpoint to send notifications. The following endpoints are available for InfluxDB 2.0 OSS, the InfluxDB Cloud 2.0 Free Plan, and the InfluxDB Cloud 2.0 Usage-based Plan: @@ -31,8 +32,8 @@ To send notifications about changes in your data, start by creating a notificati | **PagerDuty** | **{{< icon "check" >}}** | | **{{< icon "check" >}}** | | **HTTP** | **{{< icon "check" >}}** | | **{{< icon "check" >}}** | -4. In the **Name** and **Description** fields, enter a name and description for the endpoint. -5. Enter enter information to connect to the endpoint: +5. In the **Name** and **Description** fields, enter a name and description for the endpoint. +6. Enter enter information to connect to the endpoint: - For HTTP, enter the **URL** to send the notification. Select the **auth method** to use: **None** for no authentication. To authenticate with a username and password, select **Basic** and then enter credentials in the **Username** and **Password** fields. To authenticate with a token, select **Bearer**, and then enter the authentication token in the **Token** field. diff --git a/content/v2.0/monitor-alert/notification-endpoints/delete.md b/content/v2.0/monitor-alert/notification-endpoints/delete.md index 24a0dc71b..b3a65f7fb 100644 --- a/content/v2.0/monitor-alert/notification-endpoints/delete.md +++ b/content/v2.0/monitor-alert/notification-endpoints/delete.md @@ -16,9 +16,11 @@ If notifications are no longer sent to an endpoint, complete the steps below to ## Delete a notification endpoint in the UI -1. Select the **Monitoring and Alerting** icon from the sidebar. +1. In the navigation menu on the left, select **Alerts**. {{< nav-icon "alerts" >}} -2. Under **Notification Rules**, find the rule you want to delete. -3. Click the delete icon, then click **Delete** to confirm. +2. Select **Notification Endpoints** near to top of the page. + find the rule you want to delete. +3. Hover over the endpoint you want to delete and click the **{{< icon "trash" >}}** icon. +4. Click **Delete** to confirm. diff --git a/content/v2.0/monitor-alert/notification-endpoints/update.md b/content/v2.0/monitor-alert/notification-endpoints/update.md index d2624e5e4..74bcc05a8 100644 --- a/content/v2.0/monitor-alert/notification-endpoints/update.md +++ b/content/v2.0/monitor-alert/notification-endpoints/update.md @@ -16,50 +16,51 @@ To update the notification endpoint details, complete the procedures below as ne ## Add a label to notification endpoint -1. Select the **Monitoring and Alerting** icon from the sidebar. +1. In the navigation menu on the left, select **Alerts**. {{< nav-icon "alerts" >}} -2. Under **Notification Endpoints**, click **Add a label** next to the endpoint you want to add a label to. The **Add Labels** box opens. -3. To add an existing label, select the label from the list. -4. To create and add a new label: +2. Select **Notification Endpoints** near to top of the page. +3. Click **{{< icon "add-label" >}} Add a label** next to the endpoint you want to add a label to. + The **Add Labels** box opens. +4. To add an existing label, select the label from the list. +5. To create and add a new label: - In the search field, enter the name of the new label. The **Create Label** box opens. - In the **Description** field, enter an optional description for the label. - Select a color for the label. - Click **Create Label**. -5. To remove a label, hover over the label under an endpoint and click X. +6. To remove a label, hover over the label under an endpoint and click X. ## Disable notification endpoint -1. Select the **Monitoring and Alerting** icon from the sidebar. - +1. In the navigation menu on the left, select **Alerts**. {{< nav-icon "alerts" >}} - -2. Under **Notification Endpoints**, find the endpoint you want to disable. -3. Click the blue toggle to disable the notification endpoint. +2. Select **Notification Endpoints** near to top of the page. +3. Click the {{< icon "toggle" >}} toggle to disable the notification endpoint. ## Update the name or description for notification endpoint -1. Select the **Monitoring and Alerting** icon from the sidebar. - +1. In the navigation menu on the left, select **Alerts**. {{< nav-icon "alerts" >}} - -2. Under **Notification Endpoints**, hover over the name or description of the endpoint. -3. Click the pencil icon to edit the field. +2. Select **Notification Endpoints** near to top of the page. +3. Hover over the name or description of the endpoint and click the pencil icon + (**{{< icon "edit" >}}**) to edit the field. 4. Click outside of the field to save your changes. ## Change endpoint details -1. Select the **Monitoring and Alerting** icon from the sidebar. +1. In the navigation menu on the left, select **Alerts**. {{< nav-icon "alerts" >}} -2. Under **Notification Endpoints**, click the endpoint to update. -3. Update details as needed, and then click **Edit a Notification Endpoint**. For details about each field, see [Create notification endpoints](/v2.0/monitor-alert/notification-endpoints/create/). +2. Select **Notification Endpoints** near to top of the page. +3. Click the endpoint to update. +4. Update details as needed, and then click **Edit Notification Endpoint**. + For details about each field, see [Create notification endpoints](/v2.0/monitor-alert/notification-endpoints/create/). diff --git a/content/v2.0/monitor-alert/notification-endpoints/view.md b/content/v2.0/monitor-alert/notification-endpoints/view.md index 982fa4c42..399753c15 100644 --- a/content/v2.0/monitor-alert/notification-endpoints/view.md +++ b/content/v2.0/monitor-alert/notification-endpoints/view.md @@ -21,23 +21,31 @@ View notification endpoint details and history in the InfluxDB user interface (U ## View notification endpoints -- Click **Monitoring & Alerting** in the InfluxDB UI sidebar. +1. In the navigation menu on the left, select **Alerts**. {{< nav-icon "alerts" >}} - In the **Notification Endpoints** column, view existing notification endpoints. +2. Select **Notification Endpoints** near to top of the page. ## View notification endpoint details -1. Click **Monitoring & Alerting** in the InfluxDB UI sidebar. -2. In the **Notification Endpoints** column, click the name of the notification endpoint you want to view. -3. View the notification endpoint destination, name, and information to connect to the endpoint. +1. In the navigation menu on the left, select **Alerts**. + + {{< nav-icon "alerts" >}} + +2. Select **Notification Endpoints** near to top of the page. +3. Click the name of the notification endpoint you want to view. +4. View the notification endpoint destination, name, and information to connect to the endpoint. ## View notification endpoint history -1. Click **Monitoring & Alerting** in the InfluxDB UI sidebar. -2. In the **Notification Endpoints** column, hover over the notification endpoint, click the **{{< icon "view" >}}** icon, then **View History**. -The Check Statuses History page displays: +1. In the navigation menu on the left, select **Alerts**. - - Statuses generated for the selected notification endpoint - - Notifications sent to the selected notification endpoint + {{< nav-icon "alerts" >}} + +2. Select **Notification Endpoints** near to top of the page. +3. Hover over the notification endpoint, click the **{{< icon "view" >}}** icon, then **View History**. + The Check Statuses History page displays: + + - Statuses generated for the selected notification endpoint + - Notifications sent to the selected notification endpoint diff --git a/content/v2.0/monitor-alert/notification-rules/create.md b/content/v2.0/monitor-alert/notification-rules/create.md index 471f65aff..143968989 100644 --- a/content/v2.0/monitor-alert/notification-rules/create.md +++ b/content/v2.0/monitor-alert/notification-rules/create.md @@ -17,26 +17,28 @@ _For details, see [Manage checks](/v2.0/monitor-alert/checks/) and ## Create a new notification rule in the UI -1. Select the **Monitoring and Alerting** icon from the sidebar. +1. In the navigation menu on the left, select **Alerts**. {{< nav-icon "alerts" >}} -2. Under **Notification Rules**, click **+Create**. -3. Complete the **About** section: +2. Select **Notification Rules** near to top of the page. +3. Click **{{< icon "plus" >}} Create**. +4. Complete the **About** section: 1. In the **Name** field, enter a name for the notification rule. 2. In the **Schedule Every** field, enter how frequently the rule should run. 3. In the **Offset** field, enter an offset time. For example,if a task runs on the hour, a 10m offset delays the task to 10 minutes after the hour. Time ranges defined in the task are relative to the specified execution time. -4. In the **Conditions** section, build a condition using a combination of status and tag keys. +5. In the **Conditions** section, build a condition using a combination of status and tag keys. - Next to **When status is equal to**, select a status from the drop-down field. - Next to **AND When**, enter one or more tag key-value pairs to filter by. -5. In the **Message** section, select an endpoint to notify. -6. Click **Create Notification Rule**. +6. In the **Message** section, select an endpoint to notify. +7. Click **Create Notification Rule**. ## Clone an existing notification rule in the UI -1. Select the **Monitoring and Alerting** icon from the sidebar. +1. 1. In the navigation menu on the left, select **Alerts**. {{< nav-icon "alerts" >}} -2. Under **Notification Rules**, hover over the rule you want to clone. -3. Click the clone icon and select **Clone**. The cloned rule appears. +2. Select **Notification Rules** near to top of the page. +3. Hover over the rule you want to clone and click the **{{< icon "clone" >}}** icon and select **Clone**. + The cloned rule appears. diff --git a/content/v2.0/monitor-alert/notification-rules/delete.md b/content/v2.0/monitor-alert/notification-rules/delete.md index dea28950d..3b9aeeedd 100644 --- a/content/v2.0/monitor-alert/notification-rules/delete.md +++ b/content/v2.0/monitor-alert/notification-rules/delete.md @@ -13,9 +13,10 @@ related: ## Delete a notification rule in the UI -1. Select the **Monitoring and Alerting** icon from the sidebar. +1. In the navigation menu on the left, select **Alerts**. {{< nav-icon "alerts" >}} -2. Under **Notification Rules**, find the rule you want to delete. -3. Click the delete icon, then click **Delete** to confirm. +2. Select **Notification Rules** near to top of the page. +3. Hover over the rule you want to delete and click the **{{< icon "trash" >}}** icon. +4. Click **Delete** to confirm. diff --git a/content/v2.0/monitor-alert/notification-rules/update.md b/content/v2.0/monitor-alert/notification-rules/update.md index f88a832d0..dc23766cf 100644 --- a/content/v2.0/monitor-alert/notification-rules/update.md +++ b/content/v2.0/monitor-alert/notification-rules/update.md @@ -13,39 +13,38 @@ related: ## Add a label to notification rules -1. Select the **Monitoring and Alerting** icon from the sidebar. +1. In the navigation menu on the left, select **Alerts**. {{< nav-icon "alerts" >}} -2. Under **Notification Rules**, click **Add a label** next to the rule you want to add a label to. The **Add Labels** box opens. -3. To add an existing label, select the label from the list. -4. To create and add a new label: +2. Select **Notification Rules** near to top of the page. +3. Click **{{< icon "add-label" >}} Add a label** next to the rule you want to add a label to. + The **Add Labels** box opens. +4. To add an existing label, select the label from the list. +5. To create and add a new label: - In the search field, enter the name of the new label. The **Create Label** box opens. - In the **Description** field, enter an optional description for the label. - Select a color for the label. - Click **Create Label**. -5. To remove a label, hover over the label under to a rule and click X. +6. To remove a label, hover over the label under to a rule and click **{{< icon "x" >}}**. ## Disable notification rules -1. Select the **Monitoring and Alerting** icon from the sidebar. - +1. In the navigation menu on the left, select **Alerts**. {{< nav-icon "alerts" >}} - -2. Under **Notification Rules**, find the rule you want to disable. -3. Click the blue toggle to disable the notification rule. +2. Select **Notification Rules** near to top of the page. +3. Click the {{< icon "toggle" >}} toggle to disable the notification rule. ## Update the name or description for notification rules -1. Select the **Monitoring and Alerting** icon from the sidebar. - +1. In the navigation menu on the left, select **Alerts**. {{< nav-icon "alerts" >}} - -2. Under **Notification Rules**, hover over the name or description of a rule. -3. Click the pencil icon to edit the field. +2. Select **Notification Rules** near to top of the page. +3. Hover over the name or description of a rule and click the pencil icon + (**{{< icon "edit" >}}**) to edit the field. 4. Click outside of the field to save your changes. diff --git a/content/v2.0/monitor-alert/notification-rules/view.md b/content/v2.0/monitor-alert/notification-rules/view.md index bbbcbe130..7c87c7ee4 100644 --- a/content/v2.0/monitor-alert/notification-rules/view.md +++ b/content/v2.0/monitor-alert/notification-rules/view.md @@ -18,25 +18,28 @@ View notification rule details and statuses and notifications generated by notif - [View statuses generated by a check](#view-statuses-generated-by-a-notification-rule) - [View notifications triggered by a notification rule](#view-notifications-triggered-by-a-notification-rule) -To view notification rules, click **Monitoring & Alerting** in the InfluxDB UI sidebar. +**To view notification rules:** -{{< nav-icon "alerts" >}} +1. In the navigation menu on the left, select **Alerts**. + + {{< nav-icon "alerts" >}} + +2. Select **Notification Rules** near to top of the page. ## View a list of all notification rules -The **Notification Rules** column on the Monitoring & Alerting landing page displays all existing checks. +The **Notification Rules** section of the Alerts landing page displays all existing checks. ## View notification rule details -In the **Notification Rules** column, click the name of the check you want to view. +Click the name of the check you want to view. The check builder appears. Here you can view the check query and logic. ## View statuses generated by a notification rule -1. In the **Notification Rules** column, hover over the check, click the **{{< icon "view" >}}** - icon, then **View History**. - The Statuses History page displays statuses generated by the selected check. +Hover over the check, click the **{{< icon "view" >}}** icon, and then **View History**. +The Statuses History page displays statuses generated by the selected check. ## View notifications triggered by a notification rule -1. In the **Notification Rules** column, hover over the notification rule, click the **{{< icon "view" >}}** - icon, then **View History**. -2. In the top left corner, click **Notifications**. - The Notifications History page displays notifications initiated by the selected notification rule. +1. Hover over the notification rule, click the **{{< icon "view" >}}** + icon, and then **View History**. +2. In the top left corner, click **Notifications**. + The Notifications History page displays notifications initiated by the selected notification rule.