sentry/sentry-laravel

Sentry 的 Laravel SDK (https://sentry.io)

4.9.0 2024-09-19 12:58 UTC

README

Sentry for Laravel

糟糕的软件无处不在,我们已经厌倦了。Sentry 致力于帮助开发者更快地编写更好的软件,这样我们就可以回归到享受技术。如果您想加入我们 查看我们的空缺职位

Sentry 的官方 Laravel SDK

CI Latest Stable Version License Total Downloads Monthly Downloads Discord

这是 Sentry 的官方 Laravel SDK。

入门

以下安装步骤适用于 Laravel 框架的 11.x 版本。

对于旧版本的 Laravel 和 Lumen,请参阅

安装

安装 sentry/sentry-laravel

composer require sentry/sentry-laravel

通过修改 bootstrap/app.php 来启用捕获未处理的异常并报告给 Sentry

<?php

use Illuminate\Foundation\Application;
use Illuminate\Foundation\Configuration\Exceptions;
use Illuminate\Foundation\Configuration\Middleware;
use Sentry\Laravel\Integration;

return Application::configure(basePath: dirname(__DIR__))
    ->withRouting(
        web: __DIR__.'/../routes/web.php',
        commands: __DIR__.'/../routes/console.php',
        health: '/up',
    )
    ->withMiddleware(function (Middleware $middleware) {
        //
    })
    ->withExceptions(function (Exceptions $exceptions) {
        Integration::handles($exceptions);
    })->create();

或者,您可以将 Sentry 配置为 Laravel 日志通道,允许您捕获 infodebug 日志。

配置

使用以下命令配置 Sentry DSN

php artisan sentry:publish --dsn=___PUBLIC_DSN___

它创建配置文件(config/sentry.php)并将 DSN 添加到您的 .env 文件。

SENTRY_LARAVEL_DSN=___PUBLIC_DSN___

使用

use function Sentry\captureException;

try {
    $this->functionThatMayFail();
} catch (\Throwable $exception) {
    captureException($exception);
}

要了解更多关于如何使用 SDK 的信息,请参阅我们的文档。

Laravel 版本兼容性

以下列出的 Laravel 和 Lumen 版本目前都受支持

  • Laravel >= 11.x.x 在 PHP >= 8.2 上从 4.3.0 开始支持
  • Laravel >= 10.x.x 在 PHP >= 8.1 上从 3.2.0 开始支持
  • Laravel >= 9.x.x 在 PHP >= 8.0 上从 2.11.0 开始支持
  • Laravel >= 8.x.x 在 PHP >= 7.3 上从 1.9.0 开始支持
  • Laravel >= 7.x.x 在 PHP >= 7.2 上从 1.7.0 开始支持
  • Laravel >= 6.x.x 在 PHP >= 7.2 上从 1.2.0 开始支持

请注意,从版本 >= 2.0.0 开始,我们要求 PHP 版本 >= 7.2,因为我们正在使用我们的新的 PHP SDK

以下 Laravel 版本在之前版本的 Sentry SDK for Laravel 中受支持

  • Laravel <= 4.2.x0.8.x 中受支持
  • Laravel <= 5.7.x 在 PHP <= 7.0 中在 0.11.x 中受支持
  • Laravel >= 5.x.x 在 PHP >= 7.1 中在 2.14.x 中受支持

为 SDK 贡献

请参阅 CONTRIBUTING.md

获取帮助/支持

如果您需要帮助设置或配置 Laravel SDK(或在 Sentry 宇宙中的任何其他内容),请前往 Discord 上的 Sentry 社区。我们 Discord 社区中有许多乐于助人的成员等待着帮助您!

资源

  • Documentation
  • Discord
  • Stack Overflow
  • Twitter Follow

许可协议

本软件遵循 MIT 许可协议,详情请参阅 LICENSE