telemetryflow/telemetryflow-uptime

TelemetryFlow Uptime - AI驱动的Uptime监控与状态页面平台

概述

TelemetryFlow Uptime是一个全栈单仓库平台，提供Uptime监控、状态页面、身份与访问管理(IAM)、告警、审计、多租户和系统管理功能。基于NestJS后端和Vue 3前端构建，从TelemetryFlow Platform单体应用中提取并适配。

核心功能

Uptime监控

• 多协议检查: HTTP(S)、TCP、ICMP Ping、DNS
• 可配置间隔: 每个监控项的检查频率（10秒-5分钟）
• 响应时间跟踪: 基于ClickHouse时序存储的延迟测量
• Uptime计算: 实时显示每个监控项的可用率（24h/7d/30d/90d）
• SSL/TLS监控: 证书过期跟踪
• 关键词匹配: HTTP body内容验证
• 地理分布式检查: 多区域监控支持
• 计划维护窗口: 排除计划 downtime 对可用率的影响
• 领域事件: 基于事件驱动的检查结果和状态变更
• CQRS模式: 读写分离的检查调度器

状态页面

• 公共状态页面: 自定义品牌页面（/status/:slug）
• 事件管理: 创建、更新和解决事件，带时间线
• 事件时间线: 实时事件更新与状态历史
• 组件状态: 单个服务/组件的状态跟踪
• 订阅通知: 状态更新的邮件订阅
• 自定义品牌: 支持logo、颜色和自定义域名
• Uptime图表: 公共页面上的可视化可用率历史
• 计划维护: 显示计划维护窗口

IAM模块

• 多租户架构: 租户→组织→工作空间层级
• 用户管理: 完整CRUD与基于角色的访问控制
• 5级RBAC系统: 超级管理员、管理员、开发者、查看者、演示
• 基于角色的权限控制: 层级角色与22+权限
• 组管理: 带权限继承的用户组
• 区域支持: 多区域租户部署
• CQRS模式: 读写分离（33个命令，18个查询）
• 领域事件: 事件驱动架构（25+事件）

告警模块

• 告警规则引擎: 通过TFQL定义阈值告警规则
• 告警管理: 实时告警跟踪与历史
• 通知集成: 告警触发通知

AI助手

• LLM集成: 多提供商支持（OpenAI、***等）
• 加密配置: 安全存储API密钥
• 聊天界面: 前端AI助手交互

使用场景

1. 企业服务可用性监控: 跟踪核心服务（API、网站、数据库）的在线状态与响应时间
2. 公共状态页面: 向用户展示服务状态，提升透明度（如SaaS产品、电商平台）
3. 内部多租户管理: 企业内部不同团队/部门独立管理各自的服务监控
4. 告警自动化: 当服务异常时自动触发邮件、短信等通知
5. 合规审计: 通过审计日志跟踪用户操作与系统变更

配置说明

前置条件

• Node.js 18+
• pnpm 8+
• Docker & Docker Compose

Docker快速启动

bash
# 启动所有服务
docker-compose --profile all up -d

# 仅启动Uptime服务
docker-compose --profile uptime up -d

Docker配置文件

可用配置文件:

• uptime: 后端、前端、PostgreSQL、ClickHouse、Redis、NATS
• tools: Portainer
• all: 所有服务

手动配置

bash
# 克隆仓库
git clone https://github.com/telemetryflow/telemetryflow-uptime.git
cd telemetryflow-uptime
pnpm install

# 配置环境变量
cp .env.example .env
# 编辑.env文件设置配置

# 生成密钥
pnpm run generate:secrets

# 启动基础设施（PostgreSQL + ClickHouse + Redis + NATS）
docker-compose up -d

# 运行迁移和种子数据
pnpm run db:migrate:seed

# 启动开发环境（后端+前端）
pnpm run dev

5级RBAC系统

角色层级

1. 超级管理员: 全局平台管理，所有权限
2. 管理员: 组织级管理，完整CRUD权限
3. 开发者: 组织级，创建/读取/更新（无删除），无法管理用户/角色
4. 查看者: 组织级，只读访问
5. 演示: 仅演示组织，开发者权限，隔离生产数据

默认用户

API文档

运行后访问Swagger UI: http://localhost:3000/api

关键接口

• Uptime监控项: /api/v2/uptime/monitors - 监控项CRUD与检查管理
• 状态页面: /api/v2/status-pages - 状态页面管理
• 公共状态: /api/v2/status/public/:slug - 无认证的公共状态页面
• 认证: /api/v2/auth - 登录、登出、刷新、MFA
• 用户: /api/v2/iam/users - 用户管理

技术栈

后端

• 框架: NestJS 11.x
• 语言: TypeScript 5.9
• 数据库: PostgreSQL 16 + ClickHouse
• ORM: TypeORM 0.3
• 缓存: Redis7
• 消息队列: NATS JetStream
• 架构: DDD + CQRS
• API文档: Swagger/OpenAPI
• 日志: Winston
• 密码哈希: Argon2

前端

• 框架: Vue3 + Vite
• 状态管理: Pinia
• 路由: Vue Router4
• UI: 自定义组件库

基础设施

• 容器化: Docker + Docker Compose
• 包管理: pnpm（工作空间）
• 构建编排: Turborepo

许可证

Apache-2.0许可证 - 详见 LICENSE 文件