Django-GUID：为Django日志添加唯一ID的利器

Django-GUID：为Django日志添加唯一ID的利器

django-guid Inject an ID into every log message from a Django request. ASGI compatible, integrates with Sentry, and works with Celery 项目地址: https://gitcode.com/gh_mirrors/dj/django-guid

项目介绍

Django-GUID 是一个强大的Django扩展库，它确保在处理每一个请求时，都会为所有的日志消息注入一个唯一的关联ID（Request ID）。这一特性极大地简化了调试过程，因为相关日志条目现在都通过这个唯一ID串联起来。该库支持ASGI协议，意味着它兼容现代的Web服务器和异步视图。此外，Django-GUID还无缝集成了Sentry错误报告工具，并且可以与Celery任务一起使用，非常适合于分布式系统和微服务架构。

快速启动

安装Django-GUID

首先，你需要使用pip来安装Django-GUID：

pip install django-guid

配置Django项目

1. 更新设置文件 (settings.py)： 在你的INSTALLED_APPS列表中添加django_guid。

   INSTALLED_APPS = [
       # ...
       'django_guid',
   ]
   

2. 配置中间件： 将guid_middleware添加到你的MIDDLEWARE列表，建议放置在顶部以便影响所有后续的中间件日志记录。

   MIDDLEWARE = [
       'django_guid.middleware.guid_middleware',  # 确保放在合适的位置
       # 其他中间件...
   ]
   

3. 日志配置： 修改你的LOGGING设置以包含CorrelationId过滤器，这样每个日志记录都将包含请求ID。

   LOGGING = {
       'version': 1,
       'disable_existing_loggers': False,
       'filters': {
           'correlation_id': {
               '()': 'django_guid.log_filters.CorrelationId',
           },
       },
       'formatters': {
           'verbose': {
               'format': '%(levelname)s %(asctime)s [%(correlation_id)s] %(name)s: %(message)s'
           },
       },
       'handlers': {
           'console': {
               'class': 'logging.StreamHandler',
               'formatter': 'verbose',  # 使用包含correlation_id的格式器
               'filters': ['correlation_id'],
           },
       },
       'root': {
           'handlers': ['console'],
           'level': 'INFO',
       },
   }
   

测试日志输出

一旦完成上述步骤，每当有日志信息被记录时，你会看到类似下面的日志条目，其中包含了独特的[GUID]标识符：

INFO     [773fa6885e03493498077a273d1b7f2d] myapp.views 视图日志信息

应用案例和最佳实践

• 故障排查：利用唯一ID跟踪跨多个服务和组件的请求流程，迅速定位问题根源。
• 性能分析：结合监控工具，快速识别慢查询或瓶颈所在，分析特定请求链路的时间消耗。
• 跨域资源共享(CORS)：启用EXPOSE_HEADER选项，允许前端JavaScript访问日志ID，用于前后端错误追踪。

典型生态项目集成

虽然此文档没有直接提供与其它具体项目的集成示例，但Django-GUID设计上很容易与许多常见的生态项目如Sentry进行集成。在Sentry中，配置Django-GUID可以让每个错误报告自动携带同一请求下的Guid，便于在Sentry界面内准确查找相关联的日志和异常信息，加速问题解决过程。

记住，对于特定第三方服务的集成细节，参考各自的官方文档以获取更精确的指导。例如，如果你打算在Celery任务中使用Django-GUID，确保遵循Django-GUID文档中关于如何在非请求上下文中管理Guid的最佳实践。

---

以上就是对Django-GUID的基本介绍、快速启动指南及一些应用场景概览，帮助你高效地在Django项目中实现日志的关联和追踪功能。

django-guid Inject an ID into every log message from a Django request. ASGI compatible, integrates with Sentry, and works with Celery 项目地址: https://gitcode.com/gh_mirrors/dj/django-guid