paopao-ce/docs/proposal/23040412-关于使用sentry用于错误追踪与性能检测的设计.md

编号	作者	发表时间	变更时间	版本	状态
23040412	北野	2023-04-04	2023-04-04	v1.0	提议

概述

Sentry Sentry is a developer-first error tracking and performance monitoring platform that helps developers see what actually matters, solve quicker, and learn continuously about their applications.

需求

• 通过配置文件开启Sentry功能

方案

设计要点

• config.yaml中添加Sentry 功能来启用Sentry功能

设计细节

• 参考实现(PR):
  add Sentry feature support #258

疑问

1. 为什么要引入Sentry？
   添加一种对paopao-ce的错误追踪与性能检测机制。

2. 如何开启这个功能？

• 在配置文件config.yaml中的Features中添加Sentry功能项开启该功能：

  ...
  # features中加上 Sentry
  Features:
    Default: ["Meili", "LoggerMeili", "Base", "Sqlite3", "BigCacheIndex", "MinIO", "Sentry"]
    Base: ["Redis", "PhoneBind"]
  Sentry:
    Sentry: # Sentry配置
    Dsn: "http://4ea0af5cd88d4512b7e52070506c80ec@localhost:9000/2"
    Debug: True
    AttachStacktrace: True
    TracesSampleRate: 1.0
    AttachLogrus: True  # logrus是否附加到Sentry
    AttachGin: True     # gin是否附加到Sentry
  ...
  

参考文档

• sentry
• self-hosted

更新记录

v1.0(2023-04-04) - 北野

• 初始文档