Apache DevLake 数据仪表盘不显示问题的排查与解决

Apache DevLake 是一款开源的数据湖平台，用于收集、分析和可视化软件开发过程中的各种指标。在使用过程中，用户可能会遇到数据成功连接但仪表盘不显示数据的问题。本文将深入分析该问题的原因，并提供详细的解决方案。

问题现象

用户在使用 Apache DevLake 1.0.0 beta9 版本时，按照标准流程完成了以下操作：

1. 下载并配置了 docker-compose.yml 和 env.example 文件
2. 生成了加密密钥并配置到环境变量
3. 成功启动了 Docker 容器
4. 完成了 GitHub 连接配置
5. 导入了测试仓库 DevSecOps-MaturityModel

尽管数据连接显示成功，但在访问仪表盘时却无法显示任何数据。通过浏览器开发者工具检查，发现存在 WebSocket 连接错误，指向 /api/live/ws 端点。

根本原因分析

经过深入排查，该问题主要由以下几个因素导致：

1. WebSocket 连接配置不当：Grafana 服务未正确配置允许 WebSocket 连接，导致实时数据无法传输。

2. 网络端口限制：4000 端口的 WebSocket 通信可能被网络策略限制。

3. 服务依赖问题：config-ui 服务依赖的 devlake 和 mysql 服务可能存在启动异常。

4. 浏览器兼容性问题：某些浏览器对 WebSocket 的支持可能存在差异。

详细解决方案

1. 检查并修正 WebSocket 配置

确保 Grafana 服务正确配置了 WebSocket 支持。可以通过修改环境变量来允许所有来源的连接：

environment:
  GF_LIVE_ALLOWED_ORIGINS: '*'

2. 验证网络配置

检查以下网络配置项：

• 确认 4000 端口未被占用
• 检查网络规则，确保不阻止 WebSocket 流量
• 验证 Docker 网络配置是否正确

3. 检查服务状态

使用以下命令确认所有相关服务正常运行：

docker-compose ps

确保 devlake、mysql 和 config-ui 服务都处于 "Up" 状态。

4. 浏览器端测试

在浏览器控制台执行以下测试脚本，验证 WebSocket 连接：

const socket = new WebSocket("ws://localhost:4000/api/live/ws");

socket.onopen = () => console.log("连接已建立");
socket.onmessage = (e) => console.log("收到数据:", e.data);
socket.onclose = (e) => console.log(`连接关闭: ${e.code} ${e.reason}`);
socket.onerror = (e) => console.error("连接错误:", e.message);

5. 日志分析

检查各容器的日志输出，寻找可能的错误信息：

docker-compose logs config-ui
docker-compose logs devlake

预防措施

为避免类似问题再次发生，建议采取以下预防措施：

1. 在部署前仔细检查所有环境变量配置
2. 使用最新稳定版本的 Apache DevLake
3. 在网络规则中明确允许 WebSocket 通信
4. 定期检查服务健康状态
5. 保持浏览器版本更新

总结

Apache DevLake 仪表盘数据显示问题通常与 WebSocket 通信有关。通过系统性地检查服务配置、网络环境和依赖关系，大多数情况下都能有效解决问题。本文提供的解决方案不仅适用于当前版本，其排查思路也可应用于其他类似的数据可视化问题。

对于持续存在的问题，建议收集详细的日志信息并向社区寻求进一步帮助。随着 Apache DevLake 的持续发展，这类连接问题有望在后续版本中得到更好的默认处理。