Pluton通知系统深度解析:邮件、Slack、Discord与Ntfy推送,备份状态实时掌握
Pluton通知系统深度解析:邮件、Slack、Discord与Ntfy推送,备份状态实时掌握
Pluton 是一款现代化的自托管备份解决方案,支持将本地与云存储的数据进行加密备份。它的通知系统更是亮点:备份开始、成功、失败时,都能通过 邮件(SMTP)、Slack、Discord 和 Ntfy 推送 四种渠道实时提醒你,让你无需守着后台也能第一时间掌握 Pluton 备份任务的状态。本文将带你从使用与原理两个层面,完整看懂 Pluton 通知机制的设计与配置方法。
Pluton 备份计划(Backup Plans)界面:每个计划都配有独立的通知与状态管理
四种通知渠道,一次看懂
Pluton 把通知渠道分成"全局集成"和"按计划配置"两类:
| 渠道 | 配置位置 | 说明 |
|---|---|---|
| 📧 邮件(SMTP) | 全局设置 → Integrations | 支持主流邮箱服务商,可发 HTML 富文本邮件 |
| 📲 Ntfy 推送 | 全局设置 → Integrations | 配置一次认证,各计划填入 topic URL 即可 |
| 💬 Slack | 计划设置 → Notification | 每个计划单独填 Webhook URL |
| 🎮 Discord | 计划设置 → Notification | 每个计划单独填 Webhook URL |
全局集成配置界面见 IntegrationSettings.tsx,其中 SMTP 与 Ntfy 各自提供"测试发送"按钮,配置后可立即验证连通性(测试模板位于 TestEmailNotification.ts 与 TestNtfyNotification.ts)。
触发时机:什么时候会收到通知
通知的触发由事件服务驱动,BackupEventService.ts 会在备份任务的三个关键节点发出事件:
- start:备份任务启动
- success:备份成功完成(附带文件数、体积、耗时等统计)
- failure:备份失败(附带错误信息)
- replication_failure:多目标复制(Mirror)部分失败时,由 ReplicationEventService.ts 单独发出
每个渠道都可以独立选择触发时机(case):start / end / success / failure / both。前端类型定义在 plans.ts 中,其中 end 是智能选项——任务结束时会自动判断成败并发送对应的成功或失败模板。
核心架构:一次事件,多路投递
Pluton 通知系统的核心是 BackupNotification.ts。它的 send 方法会依次检查计划配置,凡是启用了的渠道都会被投递:
BackupNotification.send(plan, type, data)
├─ email.enabled → SMTPChannel.send()
├─ slack.enabled → SlackChannel.send()
├─ discord.enabled → DiscordChannel.send()
└─ push.enabled → NtfyChannel.send()
各渠道实现了统一的 NotificationChannel 接口(见 NotificationChannel.ts),保证新增渠道时不影响现有逻辑。渠道工厂 NotificationChannelResolver.ts 还负责凭据加解密:smtp.password 与 ntfy.authToken 在落库前用 Cryptr 加密存储,读取时自动解密,密钥不落地明文。
各渠道发送机制详解
邮件(SMTPChannel)
SMTPChannel.ts 基于 nodemailer 构建,端口 465 时自动启用 TLS。邮件正文并非纯文本,而是由 EJS 模板渲染的 HTML:例如备份成功模板 BackupSuccessNotification.ejs,会展示计划名称、源设备、目标存储、新增/变更文件数、总大小与耗时,并套上统一的品牌外壳(email.html)。渲染逻辑见 BackupSuccessNotification.ts。
Slack 与 Discord(Webhook)
SlackChannel.ts 与 DiscordChannel.ts 都通过向 Webhook URL 发送 POST 请求完成投递,而且消息都是"平台原生格式":
- Slack:使用 Block Kit 富文本块(header + section + 按钮),带 "View Plan" 跳转按钮;
- Discord:使用 Embed 卡片,成功为绿色、有复制失败时变为橙色并列出失败的镜像目标。
两者都会附带备份统计(文件数、体积、耗时)和时间戳,信息密度高且不刷屏。
Ntfy 推送(手机直达)
NtfyChannel.ts 支持自定义 ntfy 实例与 Bearer Token 认证。推送内容支持 Markdown 正文、优先级、Emoji 标签、自定义按钮("View Plan" 直达计划详情页),还能通过 tags 字段(如 warning)让手机通知栏显示醒目标识。对于自托管场景,这是最轻量的"手机实时告警"方案。
如何配置你的第一条通知
推荐按以下顺序操作,10 分钟完成:
- 配置全局集成:进入 Settings → Integrations,填写 SMTP 服务器、端口、账号与发件人,点击测试按钮确认邮件可达;同时配置 Ntfy(若使用自托管 ntfy,填写实例地址与 Token)。
- 打开计划通知:在目标 Backup Plan 的 Settings 中找到 Notification 标签页(组件见 PlanNotificationSettings.tsx)。
- 选择触发时机:每个渠道建议设为
failure(只报故障)或both(开始+结束都通知)。 - 填入 Webhook:Slack 在频道中创建 Incoming Webhook,Discord 在频道设置中生成 Webhook URL,分别粘贴到对应输入框。
- 点击 Test 验证:每个渠道旁都有测试按钮,会立即发送一条模拟通知,确认无误后保存即可。
💡 小贴士:多镜像复制的计划,即使主备份成功、某个镜像失败,replication_failure 事件也会单独触发通知,避免"成功通知掩盖局部失败"的盲区。
设计亮点小结
- 模板与渠道解耦:通知内容类(BaseNotification.ts 的子类)按渠道输出 HTML/JSON/Push 等不同格式,一份数据、四种呈现;
- 统一失败兜底:任何渠道发送失败都不会中断备份流程,仅记录到计划日志(
planLogger),便于事后排查; - 凭据安全:敏感字段加密入库,接口展示时自动脱敏解密(NotificationChannelResolver.ts)。
至此,从事件触发、内容渲染到多路投递的完整链路已经清晰。无论你的团队用 Slack 协作、Discord 聊天,还是习惯邮件与手机推送,Pluton 的通知系统都能让每次备份的成功与失败,都成为你"随手可查、即时可见"的状态——这就是自托管备份"安心感"的最后一块拼图。
