tarique/laravel-app-monitor

一个用于监控应用程序停机时间和服务器错误的Laravel包,并发送电子邮件通知

1.0.3 2024-06-11 09:53 UTC

This package is auto-updated.

Last update: 2024-09-12 13:24:19 UTC


README

Laravel App Monitor

Laravel App Monitor是一个用于监控Laravel应用程序中特定HTTP错误并通过电子邮件通知管理员的包。它有助于确保关键错误(如500、502、503、504、413)得到及时报告,使管理员能采取适当的行动。

安装

您可以通过Composer安装Laravel App Monitor包。在终端中运行以下命令

composer require tarique/laravel-app-monitor

发布配置

要自定义电子邮件接收者或错误通知等设置,请发布配置文件

php artisan vendor:publish --provider="Tarique\LaravelAppMonitor\AppMonitorServiceProvider" --tag=config

这会将配置文件复制到config/appmonitor.phpapp\Jobs\SendMonitorErrorNotification.php

环境配置

在您的.env文件中设置应发送通知的电子邮件地址

ADMIN_EMAIL=admin@example.com

请确保将admin@example.com替换为适当的电子邮件地址。

使用方法

Laravel App Monitor会自动检测和处理特定的HTTP错误。以下是有效使用它的方法

启用错误通知

确保在config/appmonitor.php文件中启用了错误通知

return [
    'admin_email' => env('APPMONITOR_ADMIN_EMAIL', 'admin@example.com'),
    'notify_on_down' => env('APPMONITOR_NOTIFY_ON_DOWN', true),
    'notify_on_error' => env('APPMONITOR_NOTIFY_ON_ERROR', true),
    'error_codes' => [500, 502, 503, 504, 413],
];

自定义电子邮件模板(可选)

如果您想自定义用于错误通知的电子邮件模板,可以发布默认模板

php artisan vendor:publish --provider="Tarique\LaravelAppMonitor\AppMonitorServiceProvider" --tag=views

这会将默认的电子邮件模板复制到resources/views/vendor/appmonitor/error_email.blade.php,您可以在其中进行修改以满足您的需求。

配置队列(可选)

为了避免电子邮件发送导致的延迟前端响应,您可以配置Laravel队列。在.env文件中设置队列连接

QUEUE_CONNECTION=sync

如果您使用数据库作为QUEUE_CONNECTION,则应该

QUEUE_CONNECTION=database

运行迁移以创建工作表

php artisan queue:table
php artisan migrate

启动队列工作进程以异步处理工作

php artisan queue:work

支持

如果您在使用Laravel App Monitor时遇到任何问题或有任何疑问,请在GitHub上创建一个问题或直接联系包维护者。

许可证

Laravel App Monitor是开源软件,受MIT许可证许可。