XuJiacheng
e45d14b720
- 新增 HeartbeatBuffer 类，用于收集和去重 Kafka 心跳消息，并定期将数据刷新到数据库。 - 新增 HeartbeatDbManager 类，负责与 PostgreSQL 数据库的交互，支持批量 upsert 操作。 - 新增配置文件 config.js，支持从环境变量加载配置。 - 新增 Kafka 消费者模块，支持从 Kafka 中消费心跳消息。 - 新增 Redis 集成模块，支持将日志和心跳信息推送到 Redis。 - 新增心跳消息解析器，负责解析 Kafka 消息并提取心跳字段。 - 新增日志记录工具，支持不同级别的日志输出。 - 新增指标收集器，跟踪 Kafka 消息处理和数据库操作的指标。 - 新增单元测试，覆盖 HeartbeatBuffer 和 HeartbeatDbManager 的主要功能。 - 新增数据库表结构 SQL 文件，定义 room_status_moment_g5 表的结构。 - 配置 Vite 构建工具，支持 Node.js 环境的构建。
2.9 KiB
2.9 KiB
OpenSpec 规范文档 (OpenSpec Documentation)
此目录包含 BLS OldRCU Heartbeat Backend 项目的完整 OpenSpec 规范文档。
📋 文档导览
入门文档
- OPENSPEC.md - 主规范文档
- 项目简介和核心功能
- 总体架构设计
- 快速开始命令
- 适合任何人开始这里
深度设计文档
-
architecture.md - 架构详解
- 系统架构图
- 消费者自动伸缩机制
- 双层去重策略
- 适合架构师和系统设计讨论
-
validation.md - 数据验证规范
- 消息字段定义
- 字段验证规则
- Parser 实现
- 适合数据质量和验证相关
-
deduplication.md - 去重策略规范
- 5秒缓冲去重
- 30秒写入冷却期
- 去重命中率估算
- 适合性能优化和数据去重
-
kafka.md - Kafka 处理规范
- 消费者配置
- 分区感知伸缩
- 偏移量管理
- 适合 Kafka 开发者和运维人员**
-
database.md - 数据库规范
- PostgreSQL 连接配置
- Upsert 操作和类型转换
- 批量处理实现
- 适合数据库开发者和DBA
-
testing.md - 测试规范
- 单元测试覆盖
- Parser 和 Buffer 测试
- 集成测试
- 适合 QA 和测试工程师
-
deployment.md - 部署与运维规范
- 环境配置
- 启动流程
- 监控和告警
- 故障排查
- 适合运维工程师和SRE
-
openspec-proposal.md - OpenSpec 提案
- 项目需求
- 技术选型
- 架构决策
- 风险评估
- 适合项目管理
-
openspec-apply.md - OpenSpec 应用规范
- 设计原则
- 代码组织和规范
- 性能规范
- 安全规范
- 适合所有开发者
🚀 快速使用场景
场景 1: 新开发者入门
- 阅读 OPENSPEC.md （5 分钟）
- 运行快速开始命令 （15 分钟）
- 浏览 architecture.md （30 分钟）
场景 2: 修改代码
- 修改 Parser → 读 validation.md
- 修改 Buffer → 读 deduplication.md
- 修改 Kafka → 读 kafka.md
- 修改 Database → 读 database.md
场景 3: 线上故障诊断
- 消费速度慢 → deployment.md 故障排查
- 消息验证失败 → validation.md
- 缓冲堆积 → deduplication.md
- DB 连接失败 → database.md
📊 文档统计
| 指标 | 值 |
|---|---|
| 总文档数 | 11 个 |
| 总字数 | 50,000+ |
| 代码示例 | 200+ |
| 更新日期 | 2026-03-11 |
✅ 合规检查
- OpenSpec 提案完整
- OpenSpec 应用规范完整
- 所有模块规范已生成
- 测试规范已覆盖
- 部署规范已说明
- 文档导航完整
维护者: BLS OldRCU Heartbeat Team
上次更新: 2026-03-11