xolvio/laravel-gitlab-reporter

Laravel 5 的 GitLab 错误报告器

0.1 2019-06-19 08:31 UTC

This package is not auto-updated.

Last update: 2024-09-19 09:43:17 UTC


README

为服务器上发生的异常创建问题。

如果发生异常,此包将在您的 Gitlab 项目中创建问题,并将一些额外的调试信息发布到问题中,以帮助您解决问题。

此包将联系您的 Gitlab 服务器,并检查问题描述中生成的标识符哈希是否之前已发生异常。请不要删除描述中的此行,因为这将是此包验证异常是否之前发生的唯一方式。

需要 Gitlab 版本 9 或更高版本。

安装

使用 composer 安装

composer require Xolvio/laravel-gitlab-reporter

要使用 Gitlab 报告器,您应该在 Laravel 项目的 app/Exceptions/Handler.php 文件中更改以下内容

public function report(Exception $exception)
{
    // Ignore Gitlab Report in code coverage
    // @codeCoverageIgnoreStart
    if(env('APP_ENV') == 'production' && $this->shouldReport($exception)){
        app('gitlab.report')->report($exception);
    }
    // @codeCoverageIgnoreEnd

    parent::report($exception);
}

要测试您的连接和设置是否正常工作,您可以暂时移除 env('APP_ENV') 检查,在本地运行设置,并查看是否一切正常

现在设置您的 .env 文件,包括以下变量

GITLAB_REPORT_URL=https://gitlab.com/
GITLAB_REPORT_TOKEN=
GITLAB_REPORT_PROJECT_ID=
GITLAB_REPORT_LABELS=

我建议为报告器创建一个单独的用户帐户,并且只允许它访问问题和创建问题。这样,您可以确保如果您的服务器或代码被破坏,您不会给服务器提供完全访问权限

要获取访问令牌,请转到您的 Gitlab 服务器 profile/personal_access_tokens 并为使用 API 生成一个令牌

对于项目 ID,您需要转到项目 -> 设置 -> 通用 -> 通用项目设置。应该有一个带有项目 ID 的框

添加问题标签

添加新创建的问题标签很简单,只需将逗号分隔的列表添加到 GITLAB_REPORT_LABELS=

GITLAB_REPORT_LABELS=bug,critical

如果标签在 Gitlab 中不存在,它们将被自动创建。

忽略某些异常

确保发布配置,因为设置异常无法使用 .env 文件进行

php artisan vendor:publish --tag=gitlab-report

将创建一个名为 gitlab-report.php 的文件,您可以在其中更改设置。默认情况下已添加一些异常

修改报告中字段

在某些情况下,您可能不希望报告中包含客户的密码。您可以在配置文件中扩展或替换值,包括更多不应显示在报告中的字段。所有这些字段都将替换为 [redacted]。填写为 null 的字段也将替换为 [redacted]