nilisnone/sentry-laravel

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

3.17.3 2023-08-15 07:45 UTC

This package is auto-updated.

Last update: 2024-09-15 10:10:03 UTC


README

Sentry

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

官方 Sentry SDK for Laravel

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 版本目前都受到支持

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

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

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

  • 支持 Laravel <= 4.2.x 一直支持到 0.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 宇宙中的任何其他内容)的帮助,请前往 Sentry 社区 Discord。我们的 Discord 社区有很多人乐于帮助您!

资源

  • Documentation
  • Discord
  • Stack Overflow
  • Twitter Follow

许可证

遵循MIT许可证,请参阅LICENSE