Download the PHP package exolnet/laravel-heartbeat without Composer
On this page you can find all versions of the php package exolnet/laravel-heartbeat. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package laravel-heartbeat
Laravel Heartbeat
Periodically schedule a job to send a heartbeat to a monitoring system.
Installation
Require this package with composer:
If you don't use package auto-discovery, add the service provider to the providers array in config/app.php:
And the facade to the facades array in config/app.php:
Configuration
In order to edit this package's default configuration (where for example you can define presets and configure queue monitoring), you may execute:
After that, the configuration file config/heartbeat.php will be created. This file contains all the options that can
be configured for this package. The default configuration file can be found here.
Usage
Sending Signals
Using The Heartbeat Facade
You may send heartbeat signals via the Heartbeat facade. To do so, specify the channel you want to use and call the
signal method with the arguments required by this channel. For example, with the Http channel, it may look like
this:
Alternatively, you may send the same signal using method helpers defined in the Heartbeat facade by calling the
driver method directly:
Using Artisan
Heartbeat can also be used with the heartbeat Artisan command. To do so, specify the channel and specify the
channel's arguments in the same order as their signal method. Here two examples of how to use it:
Specifying Presets
The handy preset channel allows you to define all your heartbeat configuration in the configuration file. First, let's
look at an example of a preset configuration:
This configuration can now be used by the preset channel to invoke the signal method on the http channel:
Heartbeat's default configuration list for each channel all the parameters required.
Queue Monitoring
Heartbeat can also be used to monitor your Laravel queue system. This feature is enabled by default when you have
Laravel's scheduler enabled. The preset queue is used and a file named queue.heartbeat will be created in your
storage/app folder every fifteen minutes.
To configure this, just publish the package configuration and update the queue preset.
Available Channels
Disk
Channel used to store heartbeats in a Laravel Filesystem disk.
File
Channel used to store heartbeats in a file
Http
Channel used to make a heartbeat by calling a url
Custom Channels
Heartbeat ships with a handful of channels, but you may want to write your own drivers to deliver signals via other
channels. In order to do so, define a class that contains a signal method. This method should receive as many
parameters that you need to send the signal:
Once your channel class has been defined, you may extend Heartbeat's driver to add yours. This could be added to
a service provider in the boot method:
Finally, you can now use your driver like native one:
Testing
To run the phpUnit tests, please use:
Contributing
Please see CODE OF CONDUCT for details.
Security
If you discover any security-related issues, please email [email protected] instead of using the issue tracker.
Credits
- Alexandre D'Eschambeault
- Simon Gaudreau
- Patricia Gagnon-Renaud
- All Contributors
License
This code is licensed under the MIT license. Please see the license file for more information.
