yamitzky/redashbot

Redashbot V2

Redashbot V2是一个开源的Slack机器人，专为Redash设计。（原项目为hakobera/redashbot，目前已停止维护，本项目对代码进行了几乎完全重写以持续维护。）

核心功能与特性

• 可视化图表截图：支持获取Redash查询的可视化图表截图
• 仪表板截图：支持获取Redash仪表板的完整截图
• 表格结果展示：直接展示查询结果表格（非截图形式）
• Docker部署：支持通过Docker容器便捷部署
• HTTP-based New Slack app：采用非RTM风格的新版Slack应用架构
• 开源免费：完全开源，可自由使用和定制

!screenshot.png

使用场景与适用范围

适用于需要在Slack中快速获取Redash数据的团队，帮助团队成员通过简单的Slack命令直接获取Redash的可视化图表、仪表板截图和查询结果表格，提升数据共享和协作效率。

使用方法

可视化图表

• 命令格式：@机器人名称 <查询URL>#<可视化ID>
• 示例：@redash https://your-redash-server.example.com/queries/1#2（获取ID为1的查询中ID为2的可视化图表）

仪表板

• 命令格式：@机器人名称 <仪表板URL>
• 示例：@redash https://your-redash-server.example.com/dashboards/dashboard-name（获取指定仪表板的截图）

表格结果

• 命令格式：@机器人名称 <查询URL>#table
• 示例：@redash https://your-redash-server.example.com/queries/1#table（获取ID为1的查询结果表格）

部署与配置

前置准备

需先创建Slack应用，并配置环境变量SLACK_BOT_TOKEN和SLACK_SIGNING_SECRET。具体创建步骤可参考Slack官方文档。

启动方式

完成配置后，可通过以下方式启动：

• 本地启动：npm start（需先安装依赖）
• Docker启动：docker run命令，需通过-e参数或.env文件传递环境变量

Docker部署示例

基本运行命令

bash
docker run -it --rm \
  -e SLACK_BOT_TOKEN="your-slack-bot-token" \
  -e SLACK_SIGNING_SECRET="your-slack-signing-secret" \
  -e REDASH_HOSTS_AND_API_KEYS="http://redash-server.example.com;your-redash-api-key" \
  -p 3000:3000 \
  yamitzky/redashbot:2.0.0

Docker Compose配置

项目提供docker-compose.yml支持，直接执行以下命令启动：

bash
docker-compose up

环境变量说明

必选环境变量

SLACK_BOT_TOKEN

Slack机器人令牌，用于认证Slack API访问权限，必须配置。

SLACK_SIGNING_SECRET

Slack签名密钥，用于验证Slack请求的合法性，必须配置。

可选环境变量

REDASH_HOST 和 REDASH_API_KEY

Redash服务器URL和API密钥，用于单Redash实例配置。若使用多实例，需通过REDASH_HOSTS_AND_API_KEYS配置。

REDASH_HOST_ALIAS

机器人可访问的Redash服务器别名，用于解决网络访问差异。

REDASH_HOSTS_AND_API_KEYS

多Redash实例配置，格式如下：

• 单实例（无别名）："http://redash1.example.com;TOKEN1"
• 单实例（带别名）："http://redash1.example.com;http://redash1-alias.example.com;TOKEN1"
• 多实例："http://redash1.example.com;TOKEN1,http://redash2.example.com;TOKEN2"

SLEEP_TIME

截图前等待页面加载的时间（毫秒），用于确保页面完全渲染。

BROWSER

截图使用的浏览器引擎，可选值：chromium（默认）、firefox、webkit（实验性）。

开发指南

本地开发步骤

1. 克隆仓库：git clone <仓库地址>
2. 安装依赖：npm install
3. 配置环境变量：

   bash
   export REDASH_HOST=https://your-redash-server.example.com
   export REDASH_API_KEY=your-redash-api-key
   export SLACK_BOT_TOKEN=your-slack-bot-token
   export SLACK_SIGNING_SECRET=your-slack-signing-secret
   

4. 启动服务：node index.js

部署方式

直接启动

作为Node.js应用，可通过npm start直接启动（需先安装依赖）。

Heroku部署（未测试）

可通过以下按钮快速部署到Heroku： ![Deploy]([***]