dogslow-sentry 2.0.1

概述

Dogslow是一个Django watchdog中间件，用于记录慢请求的堆栈跟踪。Dogslow-sentry需要Python 3.7+，Django 2.2+。

它最初是Bitbucket内部的一个内部项目，旨在帮助追踪操作问题。

2021年，创建了dogslow-sentry分支，以便在报告中添加Sentry特定信息，如完整堆栈跟踪、请求信息、问题分组指纹、面包屑等。

安装

安装dogslow-sentry

$ pip install dogslow-sentry

然后将dogslow_sentry.WatchdogMiddleware添加到您的Django设置文件中

MIDDLEWARE = [
    'dogslow_sentry.WatchdogMiddleware',
    ...
]

为了获得最佳效果，请将其设置为运行的第一批中间件之一。

配置

自然地，dogslow-sentry期望有一个适用于Django的Sentry配置。

您可以在您的 settings.py 文件中使用以下配置来调整 watchdog。

# Watchdog is enabled by default, to temporarily disable, set to False:
DOGSLOW = True

# Log requests taking longer than 25 seconds:
DOGSLOW_TIMER = 25

# Enable logging to Sentry
DOGSLOW_SENTRY = True

# Also log slow request tracebacks to Python logger
DOGSLOW_LOGGER = 'dogslow_sentry'
DOGSLOW_LOG_LEVEL = 'WARNING'

# Tuple of url pattern names that should not be monitored:
# (defaults to none -- everything monitored)
DOGSLOW_IGNORE_URLS = ('some_view', 'other_view')

使用方法

每个进入的 HTTP 请求在 watchdog 中都会有一个 25 秒的超时时间。如果请求没有在规定时间内返回，watchdog 就会激活，并查看请求线程的堆栈，并将回溯信息（包括所有局部堆栈变量 - Django 风格）写入日志文件。

注意，dogslow 只会查看线程的堆栈。它不会中断请求或以任何方式影响请求。因此，在生产环境中使用 dogslow 是安全的。

变更日志

2.0.1 (2023-12-08)

• 使用类似于 ISO 8601 的 YYYY-MM-DD 日期格式进行电子邮件/文件日志。

• 在 Python 3.12 上修复了弃用警告（utcnow 函数）。

• 启用了 Python 3.11、3.12 和 Django 5.0、4.2、4.1 的 CI 测试。

2.0.0 (2021-12-13)

• 为 CI 配置了 GitHub Actions。

• 启用了 Python 3.10 和 Django 4.0 的测试。

• 修复了使用 Python 3.10 时的弃用警告。

2.0.0b1 (2021-07-19)

• dogslow-sentry 分支的初始预发布版。

• 改进了 Sentry 集成。

• 放弃了 Python 2.7 支持，现在需要 Python 3.7+、Django 2.2+。

• 许多小的调整。使用 Black 重构了代码。

1.2 (2018-01-04)

• 上游 dogslow 包的最后发布版。

注意事项

Dogslow 使用多线程。它有一个单独的后台线程来处理 watchdog 超时和捕获回溯，这样原始的请求线程就不会被打断。这带来了一些后果。