Laravel中HttpResponseException未上报至Sentry问题求助

问题场景 #

在Laravel项目中，捕获异常后抛出HttpResponseException返回JSON响应时，异常无法上报至Sentry；但直接抛出原始的\Exception或\Throwable实例时，Sentry能正常接收上报，且config/sentry.php为默认配置。

原代码（无法上报） #

public function search($request): mixed
{
    try {
        $response = $this->myService->search($request);
        return is_array($response) ? new MyResource(["response" => $response]) : $response;
    } catch (\Exception $ex) {
        throw new HttpResponseException(response()->json($ex->getMessage(), 500));
    }
}

修改后代码（可正常上报） #

public function search($request): mixed
{
    try {
        $response = $this->myService->search($request);
        return is_array($response) ? new MyResource(["response" => $response]) : $response;
    } catch (\Throwable $ex) {
        throw $ex;
    }
}

原因分析 #

默认情况下，Laravel的Sentry SDK会将HttpResponseException归类为框架内部用于返回HTTP响应的异常，不会将其当作需要上报的错误事件。这类异常的设计目的是直接终止请求并返回指定响应，而非标记为应用错误，因此被SDK默认忽略。而直接抛出原始异常时，属于SDK默认捕获的错误类型，所以能正常上报。

解决方案 #

方案1：手动上报原异常后返回响应 #

在捕获异常时，先调用Sentry的API手动上报原始异常，再抛出HttpResponseException返回响应：

use Sentry\Laravel\Facades\Sentry;

public function search($request): mixed
{
    try {
        $response = $this->myService->search($request);
        return is_array($response) ? new MyResource(["response" => $response]) : $response;
    } catch (\Exception $ex) {
        // 手动上报原始异常到Sentry
        Sentry::captureException($ex);
        // 返回自定义JSON响应
        throw new HttpResponseException(response()->json($ex->getMessage(), 500));
    }
}

方案2：修改Sentry配置取消忽略该异常 #

编辑config/sentry.php，调整异常忽略规则：

1. 找到ignore_exceptions配置项，移除或注释掉Illuminate\Http\Exceptions\HttpResponseException::class（如果默认存在）：

// config/sentry.php
return [
    // 其他配置...
    'ignore_exceptions' => array_filter([
        // 注释或删除这一行
        // Illuminate\Http\Exceptions\HttpResponseException::class,
    ]),
];

2. 若SDK底层默认忽略该异常，可通过before_send回调替换为原异常上报：

// config/sentry.php
return [
    // 其他配置...
    'before_send' => function (\Sentry\Event $event, ?\Sentry\EventHint $hint): ?\Sentry\Event {
        if ($hint->exception instanceof \Illuminate\Http\Exceptions\HttpResponseException) {
            $originalException = $hint->exception->getPrevious();
            if ($originalException) {
                // 替换为原始异常上报
                $event->setException(\Sentry\Exception::createThrowable($originalException));
                return $event;
            }
        }
        return $event;
    },
];

方案3：全局异常处理器统一处理 #

在app/Exceptions/Handler.php中重写report方法，自动提取HttpResponseException的原始异常并上报：

use Illuminate\Http\Exceptions\HttpResponseException;
use Sentry\Laravel\Facades\Sentry;

class Handler extends ExceptionHandler
{
    // 其他方法...

    public function report(Throwable $exception)
    {
        // 处理HttpResponseException，上报其原始异常
        if ($exception instanceof HttpResponseException && $exception->getPrevious()) {
            Sentry::captureException($exception->getPrevious());
        }

        parent::report($exception);
    }
}

内容的提问来源于stack exchange，提问作者Gabriel Borges