From df32d597db1486abbc1cd35a5e736c4c8bec0daa Mon Sep 17 00:00:00 2001 From: ysyneu Date: Fri, 26 Jun 2026 12:27:59 +0800 Subject: [PATCH] docs: update RUM issue alert delivery modes --- en/rum/error-tracking/issue-alerts.mdx | 28 ++++++++++++++++------ zh/rum/error-tracking/issue-alerts.mdx | 32 ++++++++++++++++++-------- 2 files changed, 44 insertions(+), 16 deletions(-) diff --git a/en/rum/error-tracking/issue-alerts.mdx b/en/rum/error-tracking/issue-alerts.mdx index 6c23da9..1e4917b 100644 --- a/en/rum/error-tracking/issue-alerts.mdx +++ b/en/rum/error-tracking/issue-alerts.mdx @@ -8,6 +8,7 @@ RUM automatically aggregates error events reported by the SDK into Issues, helpi You can inspect Issues through daily checks in the console, or configure alert notifications to be notified the moment a problem occurs. Flashduty RUM's alerting capabilities include: - **Alert Notifications**: Deliver Issues as alert events to Flashduty channels, notifying responders through escalation rules +- **Webhook Delivery**: POST Issue alerts directly to your receiver, suitable for RUM-only private deployments without On-call or for custom notification pipelines - **Alert Grading**: Customize alert priority based on error attributes such as user, page, or environment - **Data Filtering**: Filter out noise data before Errors are aggregated into Issues, reducing unnecessary alerts @@ -18,10 +19,13 @@ You can inspect Issues through daily checks in the console, or configure alert n Go to "Application Details" - "Alert Settings" page - Turn on the alert switch and select multiple channels to deliver alerts to + Turn on the alert switch and choose a delivery mode: Flashduty channels or Webhook - Alert notification rules follow the escalation rules under the channel. You can set up responders for your team to assign alerts when they occur + If you choose Flashduty channels, alert notification rules follow the escalation rules under the channel. You can set up responders for your team to assign alerts when they occur + + + If you choose Webhook, enter your receiver URL. Before saving, click "Send Test Event" to verify that the URL is reachable and that your receiver can parse the sample alert event @@ -30,9 +34,18 @@ You can inspect Issues through daily checks in the console, or configure alert n -You must have the On-call service enabled to turn on Issue alerts. Note that the On-call service is charged based on active users, but members without a License can also receive alert notifications — even the free version has basic notification capabilities. +You only need the On-call service when you choose Flashduty channel delivery. With Webhook delivery, RUM sends alert events directly to the URL you configure and does not create or use an On-call integration. +## Delivery Modes + +| Delivery Mode | Use Cases | Configuration Requirements | Downstream Handling | +|---------------|-----------|----------------------------|---------------------| +| Flashduty channels | Incident collaboration, on-call dispatch, notification escalation, and Alert Pipeline processing inside Flashduty | Select one or more channels. If no channel is selected, alerts are not delivered | Issue alerts enter the selected channels and continue through integration config, noise reduction config, and escalation rules | +| Webhook | RUM-only private deployments, custom notification systems, or direct delivery to an external receiver | Enter a reachable Webhook URL. When alerts are enabled and Webhook is selected, the URL cannot be empty | RUM directly POSTs sample or real alert events to the URL. DingTalk, WeCom, and similar bot formats need your receiver to transform and forward the payload | + +The Webhook configuration area provides a "Send Test Event" button. The test sends a sample alert event to the current URL and returns the HTTP status code and result message, so you can verify network reachability and receiver parsing before saving. + ## Alert Trigger Conditions | Trigger Condition | Description | @@ -43,9 +56,10 @@ You must have the On-call service enabled to turn on Issue alerts. Note that the | **Issue Priority Upgrade** | When a higher-priority error event enters a lower-priority Issue, the Issue priority is automatically upgraded and a new alert event is triggered. For example, a P2 Issue receiving an error matching a P0 rule will be upgraded to P0 | -- An Issue triggers an alert event, which is delivered to the channel -- Whether an alert notification is triggered depends on your integration configuration, noise reduction configuration, and escalation rule configuration under the channel -- When an Issue is closed, the system triggers a close-type alert event, and its associated incident may automatically recover +- An Issue triggers an alert event. The actual destination depends on the delivery mode selected in Alert Settings +- With Flashduty channel delivery, whether a notification is triggered depends on the channel's integration config, noise reduction config, and escalation rules +- With Webhook delivery, RUM sends the event directly to the Webhook URL. Your receiver is responsible for later notification, payload transformation, and retry behavior +- When an Issue is closed, the system triggers a close-type alert event. If the alert is delivered through Flashduty channels, the associated incident may automatically recover ## Alert Severity @@ -179,7 +193,7 @@ RUM alerts work in deep collaboration with Flashduty, forming a complete alert p | Alert Processing | Flashduty Integration Config | Title customization, priority adjustment, drop/suppression | Adjust level based on affected user count, suppress repeated alerts, etc. | | Alert Dispatch | Flashduty Channel | Routing, on-call scheduling, notification channels | Dispatch to different teams, configure notification methods, etc. | -You can further process RUM alerts in the Flashduty [Alert Pipeline](/en/on-call/integration/alert-integration/alert-pipelines), such as adjusting alert levels based on affected user count, suppressing repeated alerts by time window, or customizing alert title formats. +When you choose Flashduty channel delivery, you can further process RUM alerts in the Flashduty [Alert Pipeline](/en/on-call/integration/alert-integration/alert-pipelines), such as adjusting alert levels based on affected user count, suppressing repeated alerts by time window, or customizing alert title formats. When you choose Webhook delivery, RUM alerts do not enter this On-call processing chain; handle payload transformation, routing, and notification in your receiver. ## Further Reading diff --git a/zh/rum/error-tracking/issue-alerts.mdx b/zh/rum/error-tracking/issue-alerts.mdx index 5437867..4a2f6ce 100644 --- a/zh/rum/error-tracking/issue-alerts.mdx +++ b/zh/rum/error-tracking/issue-alerts.mdx @@ -9,6 +9,7 @@ Flashduty RUM 自动将 SDK 上报的错误事件聚合为 Issue，帮助您优 您可以在控制台每日巡检 Issue，也可以配置告警通知，在问题发生时第一时间感知。Flashduty RUM 的告警能力包括： - **告警通知**：将 Issue 以告警事件投递到 Flashduty 协作空间，通过分派策略通知值班人员 +- **Webhook 投递**：将 Issue 告警直接 POST 到您的接收端，适合不启用 On-call 的 RUM 私有化环境或自建通知链路 - **告警分级**：根据错误属性（如用户、页面、环境等）自定义告警优先级 - **数据过滤**：在 Error 聚合为 Issue 之前过滤噪音数据，减少无效告警 @@ -18,9 +19,12 @@ Flashduty RUM 自动将 SDK 上报的错误事件聚合为 Issue，帮助您优 前往「应用管理」，选择目标应用，点击左侧「告警设置」 - 开启告警开关，选择将告警投递至多个协作空间 + 开启告警开关，并选择投递方式：Flashduty 协作空间或 Webhook - 告警的通知规则遵循协作空间下的分派策略，您可以为团队设定值班人员，在告警发生时分派给值班人 + 如果选择 Flashduty 协作空间，告警的通知规则遵循协作空间下的分派策略，您可以为团队设定值班人员，在告警发生时分派给值班人 + + + 如果选择 Webhook，填写您的接收端 URL。保存前可以点击「发送测试事件」验证地址是否可访问、接收端是否能解析示例告警事件 @@ -34,11 +38,20 @@ Flashduty RUM 自动将 SDK 上报的错误事件聚合为 Issue，帮助您优 - 您必须开通 On-call 服务才能开启 Issue 告警。注意 On-call - 服务按照活跃用户进行收费，但没有 License - 的成员也可以接收告警通知，即使是免费版本也有基本的通知能力。 + 只有选择「Flashduty 协作空间」投递时才需要开通 On-call 服务。选择 Webhook + 投递时，RUM 会直接向您配置的 URL 发送告警事件，不会创建或使用 On-call + 集成。 +## 投递方式 + +| 投递方式 | 适用场景 | 配置要求 | 后续处理 | +| -------- | -------- | -------- | -------- | +| Flashduty 协作空间 | 需要在 Flashduty 内完成故障协同、值班分派、通知升级和告警处理 Pipeline | 选择一个或多个协作空间；如果未选择协作空间，告警不会被投递 | Issue 告警进入对应协作空间，继续走集成配置、降噪配置和分派策略 | +| Webhook | RUM-only 私有化部署、自建通知系统，或希望把 Issue 告警直接送到外部接收端 | 填写可访问的 Webhook 地址。开启告警并选择 Webhook 时，地址不能为空 | RUM 直接向该 URL POST 示例或真实告警事件；钉钉、企业微信等机器人需要您的接收端做格式转换后再转发 | + +Webhook 配置区提供「发送测试事件」按钮。测试会向当前填写的 URL 发送一条示例告警事件，并返回 HTTP 状态码和结果信息，便于您在保存前确认网络连通性和接收端解析逻辑。 + ## 告警触发条件 | 触发条件 | 说明 | @@ -49,9 +62,10 @@ Flashduty RUM 自动将 SDK 上报的错误事件聚合为 Issue，帮助您优 | **Issue 优先级升级** | 当高优先级的错误事件进入低优先级的 Issue 时，Issue 优先级会自动升级并触发新的告警事件。例如，一个 P2 级别的 Issue 收到匹配 P0 规则的错误，会升级为 P0 并触发告警 | - - Issue 触发的是一个告警事件，此告警事件将投递到协作空间 - - 是否触发告警通知取决于您在协作空间下的集成配置、降噪配置以及分派策略配置 - 当 - Issue 关闭时，系统会触发关闭类型的告警事件，其关联的故障可能会自动恢复 + - Issue 触发的是一个告警事件，实际投递位置取决于您在告警设置中选择的投递方式 + - 选择 Flashduty 协作空间时，是否触发通知取决于协作空间下的集成配置、降噪配置以及分派策略 + - 选择 Webhook 时，RUM 直接向 Webhook URL 投递事件；后续通知、格式转换和重试策略由您的接收端负责 + - 当 Issue 关闭时，系统会触发关闭类型的告警事件；如果走协作空间投递，其关联的故障可能会自动恢复 ## 告警严重程度 @@ -193,7 +207,7 @@ RUM 告警与 Flashduty 深度协同，形成完整的告警处理链路： | 告警处理 | Flashduty 集成配置 | 标题定制、优先级调整、丢弃/抑制 | 根据影响用户数调整级别、抑制重复告警等 | | 告警分派 | Flashduty 协作空间 | 路由、值班排班、通知渠道 | 分派到不同团队、配置通知方式等 | -您可以在 Flashduty 的[告警处理 Pipeline](/zh/on-call/integration/alert-integration/alert-pipelines) 中进一步处理 RUM 告警，例如根据影响用户数调整告警级别、按时间窗口抑制重复告警、自定义告警标题格式等。 +选择 Flashduty 协作空间投递时，您可以在 Flashduty 的[告警处理 Pipeline](/zh/on-call/integration/alert-integration/alert-pipelines) 中进一步处理 RUM 告警，例如根据影响用户数调整告警级别、按时间窗口抑制重复告警、自定义告警标题格式等。选择 Webhook 投递时，RUM 告警不会进入这条 On-call 处理链路，请在您的接收端完成格式转换、路由和通知。 ## 延伸阅读