thenpingme/laravel

Zero config scheduled task monitoring for Laravel

2.4.9 2021-12-20 06:17 UTC

README

Latest Version on Packagist Build Status Total Downloads

thenping.me is a hands-free scheduled task monitoring application for your Laravel projects.

You need to have a thenping.me account in order to make use of the monitoring aspect, however, you are free to use the list command to identify your application's scheduled tasks.

  • If using Laravel ^7.0, use version 2.0.0
  • Support for ScheduledTaskFailed is available since 2.1.0
  • Version 1.3.0 is the first public-release of this companion package.

In order to avoid collisions between monitored scheduled tasks when using scheduled closures, you must ensure that each has a unique description() set.

Installation

You can install the package via composer:

composer require thenpingme/laravel

Usage

Once you have created a new project within thenping.me, you will need to run the installation command.

php artisan thenpingme:setup <project-id>

This will automatically compile your scheduled tasks, check they are valid and unique, and sync them with thenping.me, in order to be able to monitor them.

Each time you deploy your application, you should include the thenpingme:sync command as part of the deployment strategy, in order to ensure any new tasks that were added in the latest release are monitored.

php artisan thenpingme:sync

Note: Any tasks that are changed as part of a sync operation will replace their monitored counterpart, as it is not possible to track the configuration of a scheduled task between releases.

You will be notified of any changes to your monitored tasks via email notification.

If you would like to check on your application's configured tasks, you may run the thenpingme:schedule command.

To ensure that your tasks can be uniquely identified by thenping.me, use the thenpingme:verify command.

Testing

composer test

Changelog

Please see CHANGELOG for more information what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security

If you discover any security related issues, please email support@thenping.me instead of using the issue tracker.

Credits

License

The MIT. Please see License File for more information.

Laravel Package Boilerplate

This package was generated using the Laravel Package Boilerplate.