Superset 告警与报表功能配置指南

Superset 告警与报表功能配置指南

superset 项目地址: https://gitcode.com/gh_mirrors/su/superset

概述

Superset 作为一款强大的数据可视化与分析平台，提供了告警（Alerts）和报表（Reports）两大自动化功能，帮助用户及时获取关键数据变化和定期数据快照。本文将深入解析如何配置这些功能，包括基础环境准备、详细参数设置以及常见问题排查。

---

核心概念解析

告警 vs 报表

• 告警（Alerts）：当 SQL 查询结果满足预设条件时触发通知（如指标超过阈值）
• 报表（Reports）：按预定时间周期发送数据看板或图表的快照

两者均支持通过邮件或 Slack 渠道发送，但实现机制不同：

| 特性 | 告警 | 报表 | |-------------|--------------------|--------------------| | 触发条件 | SQL 条件满足时触发 | 固定时间周期触发 | | 执行频率 | 条件驱动 | 计划任务驱动 | | 内容形式 | 条件结果+可视化 | 完整可视化快照 |

---

基础环境配置

必须组件

1. 功能开关
   在 superset_config.py 中启用功能标志：

   FEATURE_FLAGS = {
       "ALERT_REPORTS": True  # 同时控制告警和报表功能
   }
   

2. 任务调度系统
   需要配置 Celery 的 Beat 调度器和 Worker：

   class CeleryConfig:
       beat_schedule = {
           "reports.scheduler": {
               "task": "reports.scheduler",
               "schedule": crontab(minute="*", hour="*"),  # 每分钟检查一次
           }
       }
   

3. 消息传递渠道（至少配置一种）：

   • 邮件：需配置 SMTP 服务器参数
   • Slack：需申请 API Token

4. 截图服务
   必须安装无头浏览器（Headless Browser）用于可视化渲染：

   • Firefox + Geckodriver（默认）
   • Chrome + Chromedriver（需额外配置）

---

详细配置指南

邮件通知配置

# SMTP 服务器配置示例（以 SendGrid 为例）
SMTP_HOST = "smtp.sendgrid.net"
SMTP_PORT = 587
SMTP_STARTTLS = True
SMTP_USER = "apikey"  # SendGrid 使用固定用户名
SMTP_PASSWORD = "your_sendgrid_key"
SMTP_MAIL_FROM = "alerts@yourdomain.com"

# 可选：自定义邮件主题前缀
EMAIL_REPORTS_SUBJECT_PREFIX = "[数据告警] "

高级技巧：
启用 DATE_FORMAT_IN_EMAIL_SUBJECT 特性标志后，可在主题中使用 strftime 格式的时间占位符（如 %Y-%m-%d），避免所有通知邮件被归入同一线程。

---

Slack 集成配置

1. 创建 Slack App：

   • 在 Slack API 控制台新建应用
   • 添加以下权限范围：
     • incoming-webhook
     • files:write
     • chat:write
     • channels:read

2. 获取 Token：

   SLACK_API_TOKEN = "xoxb-your-bot-token"
   

3. 使用注意：

   • 配置告警时直接输入频道名（无需 # 前缀）
   • 需确保机器人已加入目标频道

---

无头浏览器配置

根据所选浏览器类型配置：

Firefox（默认）

# 无需额外配置，但需确保已安装：
# - firefox-esr
# - geckodriver

Chrome

WEBDRIVER_TYPE = "chrome"
WEBDRIVER_OPTION_ARGS = [
    "--headless",
    "--disable-gpu",
    "--no-sandbox",  # Docker 环境下必须
    "--disable-dev-shm-usage"  # 限制内存使用
]

容器部署建议：
使用官方 -dev 标签的镜像（如 apache/superset:3.1.0-dev）已包含完整浏览器环境。

---

高级配置技巧

执行权限控制

默认使用告警/报表所有者的权限执行，可通过以下方式修改：

from superset.tasks.types import FixedExecutor

ALERT_REPORTS_EXECUTORS = [FixedExecutor("admin")]  # 固定使用 admin 账户

频率限制

防止过度触发：

# 最小执行间隔（秒）
ALERT_MINIMUM_INTERVAL = 600  # 10分钟
REPORT_MINIMUM_INTERVAL = 300  # 5分钟

多队列优化

建议为不同类型任务分配独立 Celery Worker：

task_annotations = {
    "email_reports.send": {"queue": "reports"},
    "sql_lab.get_sql_results": {"queue": "queries"}
}

---

常见问题排查

基础检查清单

1. 功能可见性

   • 确认 ALERT_REPORTS 特性标志已启用
   • 使用管理员账户检查设置菜单

2. 日志分析
   Celery Worker 日志包含关键错误信息：

   docker logs superset_worker --tail 100
   

典型问题解决方案

截图失败

• 现象：收到 CSV 附件但无 PNG
• 排查：
  1. 验证浏览器是否安装：

     firefox --headless --version
     

  2. 检查 WEBDRIVER 配置：

     WEBDRIVER_BASEURL = "http://superset_app:8088"  # 容器间通信地址
     

邮件发送超时

• 测试命令：

  import smtplib
  server = smtplib.SMTP('your.smtp.server', 25)
  server.quit()
  

• 云环境注意：部分云厂商默认封锁 25 端口

认证失败

• 检查 WEBDRIVER_BASEURL 是否可被 Worker 访问
• 在 SSO 环境中可能需要禁用强制 HTTPS：

  TALISMAN_CONFIG = {"force_https": False}
  

---

性能优化建议

1. 资源隔离
   为截图任务分配独立 Worker，避免影响查询性能

2. 进程管理
   使用 Prefork 模式防止内存泄漏：

   celery worker --pool=prefork --max-tasks-per-child=100
   

3. 截图参数调优

   SCREENSHOT_LOCATE_WAIT = 50    # 元素定位等待（毫秒）
   SCREENSHOT_LOAD_WAIT = 300     # 页面加载等待（毫秒）
   

---

通过本文的详细配置指南，您应该能够顺利地在 Superset 中实现自动化监控与报告功能。建议先在测试环境验证配置，再逐步应用到生产环境。

superset 项目地址: https://gitcode.com/gh_mirrors/su/superset