Skip to content

monitor-alert-flashduty.md

Latest commit

 

History

History
107 lines (69 loc) · 5.99 KB

monitor-alert-flashduty.md

File metadata and controls

107 lines (69 loc) · 5.99 KB
title Subscribe via Flashduty
summary Learn how to monitor your TiDB Cloud resource by getting alert notifications via Flashduty.

Subscribe via Flashduty

TiDB Cloud provides you with an easy way to subscribe to alert notifications via Flashduty, Slack, email, Zoom, and PagerDuty. This document describes how to subscribe to alert notifications via Flashduty.

Note:

Currently, alert subscription is available for TiDB Cloud Essential instances and TiDB Cloud Dedicated clusters.

Prerequisites

  • The subscribing via Flashduty feature is only available for organizations that subscribe to the Enterprise or Premium support plan.

  • To subscribe to alert notifications of TiDB Cloud, you must have the Organization Owner access to your organization or Project Owner access to the target project in TiDB Cloud.

Subscribe to alert notifications

To receive alert notifications of {{{ .essential }}} instance{{{ .dedicated }}} cluster, take the following steps:

Step 1. Generate a Flashduty webhook URL

  1. Generate a webhook URL by following the instructions in Flashduty Prometheus Integration.
  2. Save the generated webhook URL to use in the next step.

Step 2. Subscribe from TiDB Cloud

Alert notification subscriptions vary by your TiDB Cloud plan.

Tip:

For {{{ .dedicated }}}, the alert subscription is for all alerts in the current project. If you have multiple {{{ .dedicated }}} clusters in the project, you just need to subscribe once.

  1. In the TiDB Cloud console, navigate to the My TiDB page of your organization, and then click the Project view tab.

    Tip:

    If you are in multiple organizations, use the combo box in the upper-left corner to switch to your target organization first.

  2. In the project view, locate your target project, and then click for the project.

  3. In the left navigation pane, click Alert Subscription under Project Settings.

  4. On the Alert Subscription page, click Add Subscriber in the upper-right corner.

  5. Select Flashduty from the Subscriber Type drop-down list.

  6. Enter a name in the Name field and your Flashduty webhook URL in the Webhook URL field.

  7. Click Test Connection.

    • If the test succeeds, the Save button is displayed.
    • If the test fails, an error message is displayed. Follow the message to troubleshoot the issue and retry the connection.

  8. Click Save to complete the subscription.

Alternatively, you can also click Subscribe in the upper-right corner of the Alert page of the {{{ .dedicated }}} cluster. You will be directed to the Alert Subscription page.

Tip:

For {{{ .essential }}}, the alert subscription is for all alerts in the current instance. If you have multiple {{{ .essential }}} instances, you need to subscribe to each instance individually.

  1. In the TiDB Cloud console, navigate to the My TiDB page of your organization, and then click the name of your target {{{ .essential }}} instance to go to its overview page.

  2. In the left navigation pane, click Settings > Alert Subscription.

  3. On the Alert Subscription page, click Add Subscriber in the upper-right corner.

  4. Select Flashduty from the Subscriber Type drop-down list.

  5. Enter a name in the Name field and your Flashduty webhook URL in the Webhook URL field.

  6. Click Test Connection.

    • If the test succeeds, the Save button is displayed.
    • If the test fails, an error message is displayed. Follow the message to troubleshoot the issue and retry the connection.

  7. Click Save to complete the subscription.

Alternatively, you can also click Subscribe in the upper-right corner of the Alert page of the {{{ .essential }}} instance. You will be directed to the Alert Subscription page.

If an alert condition remains unchanged, the alert sends notifications every three hours.

Unsubscribe from alert notifications

If you no longer want to receive alert notifications, take the following steps. The steps vary by your TiDB Cloud plan.

  1. In the TiDB Cloud console, navigate to the My TiDB page of your organization, and then click the Project view tab.
  2. In the project view, locate your target project, and then click for the project.
  3. In the left navigation pane, click Alert Subscription under Project Settings.
  4. On the Alert Subscription page, locate the row of your target subscriber to be deleted, and then click ... > Unsubscribe.
  5. Click Unsubscribe to confirm the unsubscription.
  1. In the TiDB Cloud console, navigate to the My TiDB page of your organization, and then click the name of your target {{{ .essential }}} instance to go to its overview page.
  2. In the left navigation pane, click Settings > Alert Subscription.
  3. On the Alert Subscription page, locate the row of your target subscriber to be deleted, and then click ... > Unsubscribe.
  4. Click Unsubscribe to confirm the unsubscription.