File: README.md

Recommend this page to a friend!

README.md

File:	`README.md`
Role:	Documentation
Content type:	`text/markdown`
Description:	Read me
Class:	Laravel Uptime Monitor Monitor servers to verify if they are responding
Author:	By Edward Paul
Last change:
Date:	3 years ago
Size:	`5,180 bytes`

Download

Laravel Uptime - Stay Up And Running

Keep track of critical endpoints with this command-line uptime monitor. Add an endpoint, set a frequency and listen to an event if something goes down.

Installation

You can install the package via composer:

composer require infinitypaul/laravel-uptime

Configuration

To publish Uptime's configuration and migration files, run the vendor:publish command.

php artisan vendor:publish --provider="Infinitypaul\LaravelUptime\LaravelUptimeServiceProvider"

This will create a uptime.php in your config directory. The default configuration should work just fine for you, but you can take a look at it, if you want to customize the table / model names Uptime will use

Run the migration command, to generate all tables needed for Uptime.

php artisan migrate

After the migration, 2 new tables will be created: * endpoints - stores endpoint records * statuses - store the ping status of the endpoint

Commands

Once Package is Installed, The Following Commands Will Be Available To You

| Command | Descriptions | Argument | Options |----------|:-------------:|------:|------:| | endpoint:add | Add An Endpoint To Monitor | url eg: https://infinitypaul.com | Frequency in Minutes eg 20, default is 5 | | endpoint:remove | Remove An Endpoint | id of the end endpoint eg 2 | null | | uptime:status | Display The Status Of All Endpoint | null | force : check for the status of the endpoint and display as well | uptime:run | Run The Whole Endpoint To Get Status | null | force : get an immediate response of the endpoint irrespective of the minutes

Add An Endpoint

 php artisan endpoint:add https://infinitypaul.com -f 5

Add Infinitypaul.com as a frequency of 5

 php artisan endpoint:add own -f 5

Add The Base URL of your laravel project

Display All Endpoint

php artisan uptime:status

Display All the Endpoint And Status In A Beautiful Table

php artisan uptime:status --force

Check The Status Of The Endpoint Irrespective Of Their Frequency And Display As Well

Remove An Endpoint

php artisan endpoint:remove

Remove An Endpoint From The List Of EndPoint To Be Monitored

Ping All Endpoint

php artisan uptime:run

Ping All The Endpoint And Get The Up Or Down Status In Order Of Their Frequency

php artisan uptime:run --force

Ping All The Endpoint And Get The Up Or Down Status Irrespective Of Their Frequency

Scheduling

You can add the run command in your task scheduling to run every minute

php artisan uptime:run

Endpoints Down/Up Events

If you need to run additional processes when an endpoint is down or back up, you can Listen for these events:

\Infinitypaul\LaravelUptime\Events\EndpointIsBackUp

\Infinitypaul\LaravelUptime\Events\EndpointIsDown

In your EventServiceProvider add your listener(s):

/
 * The event listener mappings for the application.
 *
 * @var array
 */
protected $listen = [
    ...
    \Infinitypaul\LaravelUptime\Events\EndpointIsBackUp::class => [
        App\Listeners\URLIsBack::class,
    ],
    \Infinitypaul\LaravelUptime\Events\EndpointIsDown::class => [
        App\Listeners\YourEndPointIsDown::class,
    ],
];

The EndpointIsBackUp and EndpointIsDown event exposes the Endpoint and Status. In your listener, you can access them like so:

<?php

namespace App\Listeners;

use Infinitypaul\LaravelUptime\Events\EndpointIsBackUp;

class URLIsBack
{
    /
     * Create the event listener.
     *
     * @return void
     */
    public function __construct()
    {
        //
    }

    /
     * Handle the event.
     *
     * @param  EndpointIsBackUp  $event
     * @return void
     */
    public function handle(EndpointIsBackUp $event)
    {
        // $endpointStatus = $event->getEndpointStatus();
        // $EndpointDetails = $event->getEndpoint();

        // Do something with the Endpoint and Status.
    }
}