如何在Django项目中禁用ELB健康检查的Sentry日志？

在Django项目配置Sentry后，希望屏蔽User-Agent为ELB-HealthChecker/2.0的ELB健康检查相关日志条目，但尝试了before_send/before_breadcrumb配置和自定义中间件后，Sentry仍持续记录这类请求。

用户尝试的配置代码 #

1. Sentry初始化配置 #

def ignore_healthcheck_breadcrumbs(crumb, hint):
    # Ignore all breadcrumbs from ELB health checks
    if crumb.get('category') == 'request':
        request = crumb.get('data', {}).get('request')
        if request and request.get('headers', {}).get('User-Agent') == 'ELB-HealthChecker/2.0':
            return None
    return crumb

def before_send(event, hint):
    request = event.get('request')
    if request and 'HTTP_USER_AGENT' in request:
        user_agent = request['HTTP_USER_AGENT']
        if 'ELB-HealthChecker/2.0' in user_agent:
            return None
    return event

sentry_sdk.init(
    dsn="secret",
    integrations=[DjangoIntegration()],
    traces_sample_rate=1.0,
    before_send=before_send,
    before_breadcrumb=ignore_healthcheck_breadcrumbs,
    send_default_pii=True
)

2. 自定义中间件 #

class SentryEbsHealthCheckMiddleware:
    def __init__(self, get_response):
        self.get_response = get_response

    def __call__(self, request):
        logger.info("MIDDLEWARE LOGGING")
        logger.info(request.META)
        logger.info("MIDDLEWARE LOGGING")
        hub = Hub.current
        if request.META.get('HTTP_USER_AGENT') == 'ELB-HealthChecker/2.0':
            # Disable Sentry for ELB health checks
            with hub.push_scope():
                hub.scope.clear()
            hub.flush()
            logger.info("FLUSHING WORKED")
            return HttpResponse(status=200)
        else:
            logger.info("FLUSHING DIDN'T WORK")
            response = self.get_response(request)
            return response

问题原因 #

1. 事件类型覆盖不全：before_send仅过滤错误事件，但设置traces_sample_rate=1.0后，所有请求（包括健康检查）都会生成性能跟踪事件，这类事件不受before_send控制。
2. 中间件逻辑错误：hub.push_scope()创建的是临时作用域，修改的是临时作用域而非当前请求的作用域，退出with块后原作用域恢复，无法屏蔽当前请求的Sentry记录。

正确解决方案 #

方案1：通过Sentry初始化配置过滤所有相关事件 #

同时配置before_send（过滤错误事件）和traces_sampler（过滤性能跟踪事件），并优化逻辑适配Sentry事件结构：

def ignore_healthcheck_breadcrumbs(crumb, hint):
    if crumb.get('category') == 'request':
        request_data = crumb.get('data', {})
        headers = request_data.get('request', {}).get('headers', {})
        # 兼容不同大小写的User-Agent键
        user_agent = headers.get('User-Agent') or headers.get('user-agent')
        if user_agent == 'ELB-HealthChecker/2.0':
            return None
    return crumb

def before_send(event, hint):
    # 过滤错误事件中的健康检查请求
    request = event.get('request')
    if request:
        user_agent = None
        if 'headers' in request:
            user_agent = request['headers'].get('User-Agent') or request['headers'].get('user-agent')
        elif 'HTTP_USER_AGENT' in request:
            user_agent = request['HTTP_USER_AGENT']
        
        if user_agent and 'ELB-HealthChecker/2.0' in user_agent:
            return None
    return event

def traces_sampler(sampling_context):
    # 过滤性能跟踪中的健康检查请求
    request = sampling_context.get('request')
    if request:
        user_agent = request.META.get('HTTP_USER_AGENT')
        if user_agent == 'ELB-HealthChecker/2.0':
            return 0.0  # 完全不采样
    return 1.0  # 其他请求保持全采样

sentry_sdk.init(
    dsn="secret",
    integrations=[DjangoIntegration()],
    traces_sampler=traces_sampler,  # 替换原traces_sample_rate
    before_send=before_send,
    before_breadcrumb=ignore_healthcheck_breadcrumbs,
    send_default_pii=True
)

方案2：修正中间件写法，控制当前请求的Sentry作用域 #

若需通过中间件实现，需直接修改当前请求的Sentry作用域，而非临时作用域：

from sentry_sdk import Hub
from django.http import HttpResponse

class SentryELBHealthCheckMiddleware:
    def __init__(self, get_response):
        self.get_response = get_response

    def __call__(self, request):
        hub = Hub.current
        user_agent = request.META.get('HTTP_USER_AGENT')
        
        if user_agent == 'ELB-HealthChecker/2.0':
            # 直接修改当前作用域，禁用Sentry跟踪
            with hub.configure_scope() as scope:
                scope.clear()
                scope.set_tag("sentry_disabled", True)
            # 直接返回响应，不执行后续中间件和视图
            return HttpResponse(status=200)
        
        response = self.get_response(request)
        return response

注意：该中间件需放在settings.py的MIDDLEWARE列表中Sentry中间件之前，确保在Sentry处理请求前生效。

内容的提问来源于stack exchange，提问作者Mike D Hovhannisyan