通过 Webhook 订阅
TiDB Cloud 提供了一种简便方式,让你可以通过 Generic Webhook、email、Slack、Zoom、Flashduty 和 PagerDuty 订阅告警通知。本文介绍如何通过通用 webhook 订阅告警通知。
前提条件
通过 webhook 订阅功能仅适用于订阅了 Enterprise 或 Premium 支持计划的组织。
你需要从希望接收告警通知的平台获取一个 webhook URL(例如 Telegram、Microsoft Teams,或你自己的值班系统,该系统能够接收带有 JSON payload 的 HTTP POST 请求)。当前,TiDB Cloud 不支持自定义请求头或 payload 格式。
- 要订阅 TiDB Cloud 的告警通知,你必须对所在组织具有
Organization Owner访问权限,或对 TiDB Cloud 中的目标项目具有Project Owner访问权限。
订阅告警通知
告警通知订阅方式因你的 TiDB Cloud 计划而异。
要订阅 TiDB Cloud Dedicated 集群的告警通知,请按以下步骤操作:
在 TiDB Cloud console 中,进入你所在组织的 My TiDB 页面,然后点击 Project view 标签页。
在项目视图中,找到目标项目,然后点击该项目的 。
在左侧导航栏中,点击 Project Settings 下的 Alert Subscription。
在 Alert Subscription 页面右上角,点击 Add Subscriber。
在 Subscriber Type 下拉列表中选择 Webhook。
在 Name 字段中输入名称,并在 Webhook URL 字段中输入你的 webhook URL。
点击 Save。后端会为你测试连接并保存。
如果测试失败,会显示错误信息。请根据提示排查问题并重试连接。
或者,你也可以在目标 TiDB Cloud Dedicated 集群的 Alert 页面右上角点击 Subscribe。系统会将你引导至 Alert Subscription 页面。
如果告警条件保持不变,系统会每三小时发送一次告警通知。
取消订阅告警通知
如果你不再希望接收告警通知,请按以下步骤操作。具体步骤因你的 TiDB Cloud 计划而异。
- 在 TiDB Cloud console 中,进入你所在组织的 My TiDB 页面,然后点击 Project view 标签页。
- 在项目视图中,找到目标项目,然后点击该项目的 。
- 在左侧导航栏中,点击 Project Settings 下的 Alert Subscription。
- 在 Alert Subscription 页面中,找到要删除的目标订阅者所在行,然后点击 ... > Unsubscribe。
- 点击 Unsubscribe 确认取消订阅。