manadinho/lucent

用于跟踪生产环境异常的包

1.0.1 2023-09-12 09:36 UTC

This package is auto-updated.

Last update: 2024-09-11 16:57:31 UTC


README

Lucent

Lucent-Package

简介

lucent-package 是连接您的应用程序与 Lucent Web App 的必要组件,用于无缝错误日志记录。它被设计为集成到您希望监控错误的应用程序中。

重要:在将 lucent-package 集成到您的应用程序之前,请确保您已配置并准备好了 Lucent Web App。如果您尚未设置 Lucent 项目,请点击以下链接开始。

开始使用 Lucent

为了建立一个强大的错误跟踪系统,您的第一步是设置 Lucent 项目。详细说明和必要资源可以在以下链接中找到

设置 Lucent 项目

一旦 Lucent 项目就绪,您就可以将 lucent-package 集成到您的应用程序中,开始错误日志记录。

安装

安装 Lucent 包

composer require manadinho/lucent

发布配置

php artisan vendor:publish --provider="Manadinho\Lucent\LucentServiceProvider"

配置

在您的 Lucent 项目中创建新项目后,您将获得一个 LUCENT_KEY。将此密钥以及您的 Lucent 项目 URL 放入您希望跟踪的 Laravel 项目的 .env 文件中。现在,您的 .env 文件应包含以下条目

LUCENT_KEY=paste_your_copied_lucent_key_here
LUCENT_URL=https://example.com/lucent

导航到您的 Laravel 项目的 app/Exceptions/Handler.php 文件,并在文件开头导入 Lucent Facade

use Manadinho\Lucent\Facades\Lucent;

然后,在 Handler.php 文件的 register 方法中,通过添加对 Lucent::register($e) 的调用来增强 reportable 方法。这确保了任何抛出的异常都被 Lucent Web App 捕获和记录。以下是完整方法的示例

public function register(): void
{
    $this->reportable(function (Throwable $e) {
        Lucent::register($e);
    });
}

配置选项

通过编辑 config/lucent.php 文件来修改包的设置。以下是可用的配置选项

with_request_details [boolean]

此选项允许您选择是否记录与错误相关的请求详情。

with_app_details [boolean]

启用此选项以记录应用程序特定的详细信息,例如 PHP 版本、Laravel 版本、环境和区域。

with_user_details [boolean]

如果要将登录用户详情记录下来,请将其设置为 true。

line_count [boolean]

调整此设置以定义您希望记录的文件中的行数。