怎样在Python项目中集成Sentry以实时监控生产环境的Bug?

千丽大大_5919

千丽大大_5919

2026-07-16

822人浏览

原创

必须用sentry-sdk替代已弃用的raven,因其支持python 3.11+及异步框架,安装命令为pip install sentry-sdk,需按框架添加可选依赖(如[django]),并在应用启动最开始调用sentry_sdk.init()初始化。

怎样在python项目中集成sentry以实时监控生产环境的bug?

如何用 sentry-sdk 替代已弃用的 raven

直接装 raven 会出问题——它早在 2020 年就停止维护,且不兼容 Python 3.11+ 和现代异步框架。必须用官方推荐的 sentry-sdk,它支持 WSGI、ASGI、Celery、FastAPI、Django 等主流运行时。

安装命令是:pip install sentry-sdk。别漏掉可选依赖,比如用 FastAPI 就加 [fastapi],用 Django 就加 [django],否则某些上下文(如 request body、user info)可能抓不到。

  • 初始化必须放在应用启动最开始的位置,比如 main.py 或 settings.py 顶部,晚于其他 import 可能导致部分异常漏报
  • Django 用户不要在 settings.py 里只配 SENTRY_DSN 就以为完事——得显式调用 sentry_sdk.init(),否则 SDK 不激活
  • 本地开发时设 environment="development",避免测试日志刷爆 Sentry 项目配额

怎样让 Flask/FastAPI 自动捕获未处理异常

默认情况下,sentry-sdk 只捕获顶层未捕获异常(比如主线程崩溃),但 Web 框架通常会吞掉异常并返回 500 页面——这需要框架集成才能上报。

Flask:导入 flask 集成后,所有 500 错误自动上报,包括视图函数里抛出的 ValueError、KeyError:

sentry_sdk.init(
    dsn="https://xxx@o123456.ingest.sentry.io/123456",
    integrations=[FlaskIntegration()],
)

FastAPI:必须用 asgi 集成,且确保 app 是 ASGI 实例(即用 uvicorn 启动):

python-script-generator
python-script-generator

快速生成专业的 Python 脚本和应用代码。一键创建完整项目结构,支持CLI、API、爬虫、Bot、Django等多种项目类型,包含完整的项目结构、配置文件、依赖管理、测试、README和文档。

下载
sentry_sdk.init(
    dsn="https://xxx@o123456.ingest.sentry.io/123456",
    integrations=[AsgiMiddleware(app)],
)
  • 别把 AsgiMiddleware 当装饰器用在路由函数上——它要包装整个 app 实例
  • 如果用了 ExceptionMiddleware 自定义错误处理,Sentry 可能收不到原始异常;建议删掉自定义中间件,改用 add_exception_handler 注册 Sentry 的 capture_exception
  • Flask 的 before_request 里出错不会触发 Sentry——因为还没进视图,需手动 sentry_sdk.capture_exception(e)

为什么有些异常没上报?排查 before_send 和采样率

常见假象是“明明崩了却没看到事件”——大概率被 before_send 过滤或采样掉了。SDK 默认开启 1.0(100%)采样,但生产环境常配 sample_rate=0.1,意味着 90% 的相同异常被丢弃。

更隐蔽的是 before_send 回调:有人为过滤 404、健康检查失败等非关键错误,但写错逻辑会导致全部拦截:

def before_send(event, hint):
    if "404" in str(event.get("message", "")):
        return None  # ← 这里返回 None 就丢弃事件
    return event
  • 检查 sentry_sdk.get_client().options["sample_rate"] 运行时值,确认不是被覆盖成 0
  • before_send 抛异常也会静默丢弃事件,务必加 try/except 包裹
  • 异步任务(如 Celery)需单独 init,且必须传 enable_tracing=True 才能链路追踪,否则只报顶层异常

怎么给 Sentry 事件附加用户、请求、标签等上下文

光有 traceback 不够定位问题。关键字段要手动塞:用户 ID、请求 URL、订单号、Git commit hash。这些不是自动带的,得靠 set_tag、set_user、set_context。

例如,在 FastAPI 的依赖函数里绑定当前用户:

@app.middleware("http")
async def add_sentry_context(request: Request, call_next):
    sentry_sdk.set_user({"id": request.state.user_id})
    sentry_sdk.set_tag("endpoint", request.url.path)
    return await call_next(request)
  • set_user 接受 {"id": "...", "email": "...", "username": "..."},只传 id 最安全,避免 GDPR 风险
  • 敏感字段(如密码、token)绝不能进 set_extra——Sentry 默认记录所有变量值,可用 before_send 清洗 event["extra"]
  • Django 中 request.POST 默认不上传,要开 send_default_pii=True,但生产环境慎用

真实线上环境里,最常被忽略的是异步任务的上下文隔离——一个 Celery worker 处理多个任务,set_tag 不自动清空,上次任务的 tag 会污染下一次。必须在任务开头重置,或用 with sentry_sdk.push_scope() 包裹。

Python免费学习笔记(深入):立即使用
在学习笔记中,你将探索 Python 的核心概念和高级技巧!

相关专题

更多
python打包成可执行文件
python打包成可执行文件

本专题为大家带来python打包成可执行文件相关的文章,大家可以免费的下载体验。

2023.07.20

1651

4

python能做什么
python能做什么

python能做的有:可用于开发基于控制台的应用程序、多媒体部分开发、用于开发基于Web的应用程序、使用python处理数据、系统编程等等。本专题为大家提供python相关的各种文章、以及下载和课程。

2023.07.25

4124

7

format在python中的用法
format在python中的用法

Python中的format是一种字符串格式化方法,用于将变量或值插入到字符串中的占位符位置。通过format方法,我们可以动态地构建字符串,使其包含不同值。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

2023.07.31

1669

3

python教程
python教程

Python已成为一门网红语言,即使是在非编程开发者当中,也掀起了一股学习的热潮。本专题为大家带来python教程的相关文章,大家可以免费体验学习。

2023.08.03

23857

23

python环境变量的配置
python环境变量的配置

Python是一种流行的编程语言,被广泛用于软件开发、数据分析和科学计算等领域。在安装Python之后,我们需要配置环境变量,以便在任何位置都能够访问Python的可执行文件。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.04

2927

5

python eval
python eval

eval函数是Python中一个非常强大的函数,它可以将字符串作为Python代码进行执行,实现动态编程的效果。然而,由于其潜在的安全风险和性能问题,需要谨慎使用。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.04

2947

5

scratch和python区别
scratch和python区别

scratch和python的区别:1、scratch是一种专为初学者设计的图形化编程语言,python是一种文本编程语言;2、scratch使用的是基于积木的编程语法,python采用更加传统的文本编程语法等等。本专题为大家提供scratch和python相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.11

1143

5

python合并两个列表
python合并两个列表

Python是一种强大的编程语言,具有许多方便的功能和工具。在Python中,有多种方法可以合并两个列表。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

2023.08.10

596

4

python是前端还是后端
python是前端还是后端

Python属于前端也属于后端,其灵活性和丰富的生态系统使得开发人员能够在不同的领域中灵活运用。本专题为大家提供python相关的文章、下载、课程内容,供大家免费下载体验。

2023.08.11

2283

5

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程