Sign inSign up

hanxi/tracely

By hanxi

Updated 3 months ago

Tracely - 轻量级错误追踪系统

Image
Developer tools
Web servers
Monitoring & observability
0

7.0K

hanxi/tracely repository overview

GitHub License Docker Image Version Docker Pulls GitHub Release Visitors Visitors

Tracely

一个轻量级的前端监控平台,支持 错误收集用户活跃统计应用安装/升级追踪,可自托管部署。

功能特性

  • 错误收集:自动捕获 JS 运行时错误、Promise 异常、Vue 组件错误
  • 自定义事件:支持自定义事件上报和统计,灵活的元数据支持
  • 应用追踪:安装/升级次数统计,版本和平台分布分析
  • 数据概览:实时展示 PV/UV、错误总数、安装/升级、Top 事件排行
  • 安全认证:HMAC 签名验证 + JWT 登录,限速保护
  • 错误去重:相同错误合并记录,统计出现次数
  • 事件白名单:配置文件控制允许上报的事件类型
  • 内嵌 Dashboard:前端资源打包到后端,单个二进制文件即可运行
  • 现代化 UI:基于 Nuxt UI,支持明暗色模式、响应式布局
  • 多应用支持:支持多应用配置,Dashboard 中切换查看

在线体验: https://tracely.hanxi.cc/ (用户名:admin / 密码:admin123


快速开始

# Docker Compose 一键部署
mkdir tracely && cd tracely
curl -o docker-compose.yaml https://raw.githubusercontent.com/hanxi/tracely/main/docker-compose.yaml
docker compose run --rm tracely ./scripts/gen-config.sh init
docker compose up -d
# 访问 http://localhost:3001
# 本地构建
make build    # 一键构建前端 + 后端
./tracely     # 运行

详细部署说明见 快速开始文档


项目结构

tracely/
├── internal/            # 后端核心(config, middleware, handler, model)
├── sdk/
│   ├── go/tracely/      # Go SDK
│   └── ts/              # TypeScript SDK (@imhanxi/tracely-sdk)
├── dashboard/           # Vue 3 + Nuxt UI Dashboard
├── docs/                # 完整文档
├── config.example.yaml  # 配置模板
├── Makefile             # 构建脚本
└── Dockerfile           # Docker 镜像

文档

文档说明
快速开始安装、部署和首次使用
配置详解配置文件说明和数据库设计
Dashboard面板功能介绍
TypeScript SDK前端错误捕获和事件上报
Go SDK后端错误上报和事件追踪
API 参考HTTP API 接口文档
系统架构架构总览和核心模块
安全设计认证、限速和数据隔离
开发指南环境搭建和扩展指南
部署指南Docker 和生产环境部署
故障排查常见问题和排查方法
技术决策技术选型和路线图

致谢

感谢使用 Tracely!如有问题或建议,欢迎提交 Issue 或 PR。

Tag summary

Content type

Image

Digest

sha256:a2d11e72c

Size

16.4 MB

Last updated

3 months ago

docker pull hanxi/tracely