cerealkiller/error-logger-laravel-sdk

ErrorLogger 的 Laravel SDK

v1.0.2 2020-09-26 15:20 UTC

README

ErrorLogger

Laravel 7.x 包,用于将错误记录到 error-logger.netlify.app

Latest Stable Version Total Downloads License

安装

您可以通过 Composer 安装此包。

composer require cerealkiller/error-logger-laravel-sdk

然后使用 artisan 发布包的配置和迁移文件。

php artisan vendor:publish --provider="ErrorLogger\ErrorLoggerServiceProvider"

然后调整配置文件(config/errorlogger.php)以符合您的需求。

注意:默认情况下,只有本地环境会报告错误。要修改此设置,请编辑 errorlogger 配置。

配置变量

剩下的工作是在 .env 文件中定义 env 配置变量。

ERRORLOGGER_API_KEY=

ERRORLOGGER_API_KEY 是您的配置文件密钥,它授权您的账户访问 API。

error-logger.netlify.app 获取 API_KEY

设置

接下来是将 errorlogger 驱动器添加到 logging.php 文件中。

'channels' => [
    'errorlogger' => [
        'driver' => 'errorlogger',
    ],
],

配置完 ErrorLogger 通道后,您可以将它添加到堆栈部分。

'channels' => [
    'stack' => [
        'driver' => 'stack',
        'channels' => ['single', 'errorlogger'],
    ],
],

前端

要捕获前端错误,请将此 include blade 指令添加到您想记录错误的文件顶部。

@include('errorlogger::js-errorlogger-client')

测试

现在测试看看它是否工作,您有两种方法可以做到这一点。

选项 1
  • 在您的终端中运行此命令
php artisan errorlogger:test
选项 2
  • 在您的应用程序中运行此代码,以查看异常是否被 ErrorLogger 接收。
throw new \Exception('Testing my application!');

一切就绪!祝您编码愉快 :)

版本控制

ErrorLogger-Laravel-SDK 尽可能按照语义版本控制指南进行版本控制。

版本号将以以下格式进行编号

<major>.<minor>.<patch>

并按照以下指南构建

  • 破坏向后兼容性会提升主版本,并重置次要和补丁版本。

  • 在不破坏向后兼容性的情况下添加新功能会提升次要版本并重置补丁版本。

  • 错误修复和其它更改会提升补丁版本。

  • 不会单独维护次要版本,建议您升级到下一个次要版本。

主要版本将通过独立的分支进行维护。

许可证

ErrorLogger-Laravel-SDK 包是开源软件,受 Apache License 2.0 许可证的许可。