遥测分析平台

一个开源的遥测数据收集与分析平台,支持用户交互跟踪、应用健康监控及AI驱动的分析功能。

  • by ItsAThneed
  • JavaScript
  • 本地部署
  • 更新于
在 GitHub 查看 itsathneed/telemetry-solution-mcp

使用说明

遥测解决方案MCP

一个全面的、开源的遥测数据收集和分析平台,专为现代应用而设计。通过集成的模型上下文协议(MCP)支持人工智能分析,跟踪用户交互,监控应用程序健康状况,并深入了解应用程序的使用模式。

特性

  • 🔒 设计安全 -OAuth身份验证、加密数据传输、SQL注入保护
  • 📊 丰富的分析 -会话跟踪、用户行为分析、错误监控
  • 🤖 LLM集成 -用于人工智能分析和洞察的MCP服务器
  • 🚀 轻松部署 -CloudFlare+Neon PostgreSQL与Docker用于本地开发
  • 📱 灵活的API -适用于任何应用程序平台的RESTful端点
  • 🎯 身份跟踪 -基于硬件的身份,可选用户关联

快速开始

先决条件

  • Node.js 18+
  • Docker和Docker Compose(用于本地开发)
  • Git

安装

  1. 克隆存储库

    git clone https://github.com/your-username/telemetry-solution-mcp.git
    cd telemetry-solution-mcp
    
  2. 安装依赖项

    npm install
    
  3. 启动本地开发环境

    npm run dev:setup    # Sets up local database with Docker
    npm run dev:seed     # Generates sample data
    npm run dev          # Starts all services
    
  4. 访问仪表板

    • 数据查看器:http://localhost:3000
    • APIhttp://localhost:3001/api/v1
    • API文件:http://localhost:3001/docs

建筑

该解决方案由四个主要部分组成:

  • 数据库 -PostgreSQL遥测数据存储
  • API服务器 -Express.js API用于遥测接收和检索
  • 数据阅读器 -用于分析和可视化的React仪表板
  • MCP服务器 -LLM集成的模型上下文协议服务器

基本用法

从应用程序记录遥测数据

// Start a telemetry session
const session = await fetch('http://your-api/v1/sessions/start', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    identity: 'unique-hardware-signature',
    app_name: 'MyApp',
    app_version: '1.0.0',
    user_id: 'optional-user-id'
  })
});

// Log an action
await fetch('http://your-api/v1/actions', {
  method: 'POST',
  headers: {
    'Authorization': 'Bearer YOUR_API_KEY',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    iau_id: session.iau_id,
    session_id: session.session_id,
    category: 'Button Press',
    subcategory: 'Login Button',
    data_type: 'text',
    data_value: 'success'
  })
});

文档

发展

地方发展设置

  1. 环境配置

    cp .env.example .env
    # Edit .env with your local configuration
    
  2. 数据库设置

    npm run db:setup     # Initialize database
    npm run db:migrate   # Run migrations
    npm run db:seed      # Generate sample data
    
  3. 运行测试

    npm test            # Run all tests
    npm run test:unit   # Unit tests only
    npm run test:api    # API integration tests
    

贡献

  1. 分叉存储库
  2. 创建要素分支: git checkout -b feature/new-feature
  3. 进行更改并添加测试
  4. 确保所有测试通过: npm test
  5. 提交您的更改: git commit -am 'Add new feature'
  6. 推到分支: git push origin feature/new-feature
  7. 提交拉取请求

部署

生产部署(CloudFlare+Neon)

查看我们的 部署指导 有关以下内容的详细说明:

  • 设置Neon PostgreSQL
  • 部署到CloudFlare页面/工作者
  • 配置OAuth身份验证
  • 环境变量设置

Docker部署

docker-compose -f docker-compose.prod.yml up -d

安全

该项目实施了几个安全最佳实践:

  • 所有终结点的API密钥身份验证
  • 参数化查询以防止SQL注入
  • 输入验证和净化
  • 对传输中的数据实施HTTPS
  • OAuth 2.0用于用户身份验证

许可证

本项目根据知识共享署名-非商业4.0国际许可协议获得许可-请参阅 许可证 文件以获取详细信息。

商业用途:此软件仅供个人、教育和研究使用。有关商业许可选项,请联系[您的电子邮件]。

支持

路线图

  • []实时分析仪表板
  • []移动SDK支持
  • []高级可视化组件
  • []数据导出功能
  • []自定义警报系统

内置于❤️ 面向开发者社区