Просмотр исходного кода

docs(kb): kb/41 加企微告警消息样式与失败不静默约定

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01HAeFesmMXaZSrNTdFXE8Hu
tianyu.chu 1 неделя назад
Родитель
Сommit
a5d0787474
1 измененных файлов с 14 добавлено и 0 удалено
  1. 14 0
      kb/41-开发规范.md

+ 14 - 0
kb/41-开发规范.md

@@ -305,6 +305,20 @@ flowchart LR
 - `feat: xxx fix: yyy docs: zzz` —— 一条 commit 混多个 type
 - `feat: 新增了一大堆表` —— scope 和具体目标不明
 
+### 3.5 企微告警消息
+
+告警统一走 `dw_base/alerter/alerter.py`,机器人 key 配在 `conf/alerter.ini`,按通道名取。`Alerter` 只负责发,消息拼装由调用方做——各 monitor 的标题与字段各不相同,塞进封装只会变成参数堆。
+
+markdown 样式对齐 DS 自带告警(同一个群里看着不割裂):
+
+- 标题整行上色:`### <font color="warning">XXX 告警</font>`;异常用 `warning`,正常用 `info`
+- 正文**字段名默认色,只给值上色**:`> 状态:<font color="warning">失败</font>`
+- 元信息(检测时间、项目名等)不上色
+- 时间用服务器本地时区,格式 `yyyy-MM-dd HH:mm:ss`
+- 企微只认三种颜色:`info` 绿 / `comment` 灰 / `warning` 橙红
+
+发送侧四类失败一律抛异常不静默:配置文件缺失、通道未注册、key 仍是占位符、企微返回 `errcode != 0`。告警发不出去必须让调度看见,否则问题被双重掩盖。
+
 ## 4. 数仓开发文件组织
 
 > 讲 DDL 与计算 SQL 怎么在 `jobs/` 与 `manual/ddl/` 下组织;本节管"文件放哪",§3 管"代码怎么写"。