通过 Slack 订阅
TiDB Cloud 为你提供了便捷的方式,通过 Slack、email、Zoom、Flashduty 和 PagerDuty 订阅报警通知。本文档介绍如何通过 Slack 订阅报警通知。
前提条件
通过 Slack 订阅功能仅对订阅了 Enterprise 或 Premium 支持计划的组织开放。
要订阅 TiDB Cloud 的报警通知,你必须拥有组织的
Organization Owner访问权限,或在 TiDB Cloud 中拥有目标项目的Project Owner访问权限。
订阅报警通知
第 1 步:生成 Slack webhook URL
- 如果你还没有 Slack 应用,创建一个 Slack 应用。点击 Create New App,选择 From scratch。输入名称,选择要关联的 workspace,然后点击 Create App。
- 进入你的应用设置页面。你可以通过 应用管理控制台 加载其设置。
- 点击 Incoming Webhooks 标签页,然后将 Activate Incoming Webhooks 切换为 ON。
- 点击 Add New Webhook to Workspace。
- 选择你希望接收报警通知的频道,然后点击 Authorize。如果你需要将 incoming webhook 添加到私有频道,必须先进入该频道。
你可以在 Webhook URLs for Your Workspace 部分看到一个新条目,格式如下:https://hooks.slack.com/services/T00000000/B00000000/XXXXXXXXXXXXXXXXXXXXXXXX。
第 2 步:在 TiDB Cloud 中订阅
报警通知订阅方式根据集群计划有所不同。
提示:
报警订阅针对当前项目下的所有报警。如果你在该项目下有多个集群,只需订阅一次即可。
在 TiDB Cloud 控制台 中,使用左上角的下拉框切换到你的目标项目。
在左侧导航栏,点击 Project Settings > Alert Subscription。
在 Alert Subscription 页面,点击右上角的 Add Subscriber。
在 Subscriber Type 下拉列表中选择 Slack。
在 Name 字段输入名称,在 URL 字段输入你的 Slack webhook URL。
点击 Test Connection。
- 如果测试成功,会显示 Save 按钮。
- 如果测试失败,会显示错误信息。请根据提示排查问题并重试连接。
点击 Save 完成订阅。
另外,你也可以在集群的 Alert 页面右上角点击 Subscribe,会跳转到 Alert Subscription 页面。
如果报警条件持续未变,报警会每隔三小时发送一次通知。
取消订阅报警通知
如果你不再希望接收报警通知,请按照以下步骤操作。具体步骤根据集群计划有所不同。
1. 在 [TiDB Cloud 控制台](https://tidbcloud.com) 中,使用左上角的下拉框切换到你的目标项目。 2. 在左侧导航栏,点击 **Project Settings** > **Alert Subscription**。 3. 在 **Alert Subscription** 页面,找到你要删除的订阅者所在行,然后点击 **...** > **Unsubscribe**。 4. 点击 **Unsubscribe** 以确认取消订阅。