Django测试中Airbrake通知为何无法触发？

这个问题我之前也碰到过，大概率是Django测试环境的日志配置或者pybrake的测试自动禁用机制在搞鬼，咱们一步步排查解决：

1. 先排查Pybrake在测试环境是否被自动禁用 #

很多APM工具（包括pybrake）会自动检测是否处于测试环境，默认关闭上报功能，避免测试数据污染仪表盘。你可以先做这些检查：

• 打开测试环境配置文件（比如settings/test.py），查看BRAKE或PYBRAKE配置项，确认ENABLED字段是否被设为False。如果是，改成True即可：

  # settings/test.py
  BRAKE = {
      'project_id': 'your-project-id',
      'project_key': 'your-project-key',
      'environment': 'test',
      'ENABLED': True  # 确保这个值为True
  }
  

• 如果配置里没有ENABLED字段，也可以在测试用例的setUp方法里手动启用pybrake：

  from django.test import TestCase
  from django.conf import settings
  import pybrake
  
  class SessionRecommendationsTest(TestCase):
      def setUp(self):
          super().setUp()
          # 初始化并启用pybrake通知器
          self.notifier = pybrake.Notifier(
              project_id=settings.BRAKE['project_id'],
              project_key=settings.BRAKE['project_key'],
              environment=settings.BRAKE['environment']
          )
          self.notifier.enabled = True
  

2. 检查测试环境的日志配置是否包含Pybrake Handler #

Django的测试环境可能会重载日志配置，导致pybrake的handler没被加入处理链。你需要确认测试环境的LOGGING配置里，pybrake的handler是生效的：

# settings/test.py
LOGGING = {
    'version': 1,
    'disable_existing_loggers': False,
    'handlers': {
        'airbrake': {
            'level': 'ERROR',
            'class': 'pybrake.LoggingHandler',
            'notifier': pybrake.Notifier(
                project_id=settings.BRAKE['project_id'],
                project_key=settings.BRAKE['project_key'],
                environment=settings.BRAKE['environment']
            ),
        },
    },
    'loggers': {
        # 给目标模块的logger绑定airbrake handler
        'lucy_web.lib.session_recommendations': {
            'handlers': ['airbrake'],
            'level': 'ERROR',
            'propagate': True,
        },
    },
}

3. 验证测试中的日志是否真的被触发 #

有时候日志看似被调用，但实际因为logger级别或传播设置没被处理。可以用Django的capture_logs工具验证：

from django.test import TestCase, capture_logs
from lucy_web.lib.session_recommendations import log_something

class LoggingTest(TestCase):
    def test_log_is_generated(self):
        with capture_logs('ERROR') as logs:
            log_something()
            # 验证日志是否被捕获到
            self.assertEqual(len(logs), 1)
            self.assertEqual(logs[0]['message'], 'Logging something...')

如果测试通过，说明日志确实生成了，但没传到pybrake，回到步骤1、2检查配置；如果测试失败，说明logger级别设置过高（比如设成了CRITICAL），需要调整为ERROR。

4. 手动在测试中触发Pybrake上报 #

如果前面的排查都没问题，可以手动调用pybrake的notify方法，测试是否能正常上报：

from django.test import TestCase
from django.conf import settings
import pybrake
import logging

class PybrakeNotificationTest(TestCase):
    def test_manual_notify(self):
        notifier = pybrake.Notifier(
            project_id=settings.BRAKE['project_id'],
            project_key=settings.BRAKE['project_key'],
            environment=settings.BRAKE['environment']
        )
        notifier.enabled = True
        
        # 手动创建日志记录并上报
        record = logging.makeLogRecord({
            'msg': 'Test error from Django TestCase',
            'levelno': logging.ERROR,
            'name': 'lucy_web.lib.session_recommendations'
        })
        response = notifier.notify(record)
        
        # 可选：检查响应是否成功
        self.assertEqual(response.status_code, 200)

如果手动上报能在Airbrake仪表盘看到记录，说明问题出在日志handler的配置上；如果手动也不行，大概率是网络或密钥问题（不过shell里能上报，这个概率很低）。

内容的提问来源于stack exchange，提问作者Kurt Peek