README

We all dream of servers that need no maintenance at all. But unfortunately in reality this is not the case. Disks can get full, processes can crash, the server can run out of memory...

This package keeps an eye on the health of all your servers. There are a few checks that come out of the box. Adding new checks is a breeze.

When something goes wrong it can notify you via Slack or mail. Here's how a Slack notification look like:

Behind the scenes Laravel's native notification system is leveraged so you can use one of the many notification drivers.

Documentation

The full documentation is available on our documentation site.

Postcardware

You're free to use this package (it's MIT-licensed), but if it makes it to your production environment we highly appreciate you sending us a postcard from your hometown, mentioning which of our package(s) you are using.

Our address is: Spatie, Samberstraat 69D, 2060 Antwerp, Belgium.

All received postcards are published on our website.

Installation

You can install this package via composer using this command:

composer require spatie/laravel-server-monitor

Next, you must install the service provider:

// config/app.php
'providers' => [
    ...
    JohnNguyen\ServerMonitor\ServerMonitorServiceProvider::class,
];

You can publish the migrations with:

php artisan vendor:publish --provider="JohnNguyen\ServerMonitor\ServerMonitorServiceProvider" --tag="migrations"

After the migration has been published you can create the hosts and checks tables by running the migrations:

php artisan migrate

You must publish the config-file with:

php artisan vendor:publish --provider="JohnNguyen\ServerMonitor\ServerMonitorServiceProvider" --tag="config"

This is the contents of the published config file:

return [

    /*
     * These are the checks that can be performed on your servers. You can add your own
     * checks. The only requirement is that they should extend the
     * `JohnNguyen\ServerMonitor\Checks\CheckDefinitions\CheckDefinition` class.
     */
    'checks' => [
        'diskspace' => JohnNguyen\ServerMonitor\CheckDefinitions\Diskspace::class,
        'elasticsearch' => JohnNguyen\ServerMonitor\CheckDefinitions\Elasticsearch::class,
        'memcached' => JohnNguyen\ServerMonitor\CheckDefinitions\Memcached::class,
        'mysql' => JohnNguyen\ServerMonitor\CheckDefinitions\MySql::class,
    ],

    /*
     * The performance of the package can be increased by allowing a high number
     * of concurrent ssh connections. Set this to a lower value if you're
     * getting weird errors running the check.
     */
    'concurrent_ssh_connections' => 5,

    /*
     * This string will be appended to the ssh command generated by the package.
     */
    'ssh_command_suffix' => '',

    'notifications' => [

        'notifications' => [
            JohnNguyen\ServerMonitor\Notifications\Notifications\CheckSucceeded::class => [],
            JohnNguyen\ServerMonitor\Notifications\Notifications\CheckRestored::class => ['slack'],
            JohnNguyen\ServerMonitor\Notifications\Notifications\CheckWarning::class => ['slack'],
            JohnNguyen\ServerMonitor\Notifications\Notifications\CheckFailed::class => ['slack'],
        ],

        /*
         * To avoid burying you in notifications, we'll only send one every given amount
         * of minutes when a check keeps emitting warning or keeps failing.
         */
        'throttle_failing_notifications_for_minutes' => 60,

        'mail' => [
            'to' => 'your@email.com',
        ],

        'slack' => [
            'webhook_url' => env('SERVER_MONITOR_SLACK_WEBHOOK_URL'),
        ],

        /*
         * Here you can specify the notifiable to which the notifications should be sent. The default
         * notifiable will use the variables specified in this config file.
         */
        'notifiable' => \JohnNguyen\ServerMonitor\Notifications\Notifiable::class,

        /*
         * The date format used in notifications.
         */
        'date_format' => 'd/m/Y',
    ],

    /*
     * To add or modify behaviour to the `Check` model you can specify your
     * own model here. The only requirement is that they should
     * extend the `Check` model provided by this package.
     */
    'check_model' => JohnNguyen\ServerMonitor\Models\Check::class,

    /*
     * Right before running a check it's process will be given to this class. Here you
     * can perform some last minute manipulations on it before it will
     * actually be run.
     *
     * This class should implement JohnNguyen\ServerMonitor\Manipulators\Manipulator
     */
    'process_manipulator' => JohnNguyen\ServerMonitor\Manipulators\Passthrough::class,
];

Changelog

Please see CHANGELOG for more information what has changed recently.

Testing

To run the tests you'll have to start the included node based dummy ssh server first in a separate terminal window.

cd tests/server
npm install
./start_server.sh

With the server running, you can start testing.

vendor/bin/phpunit

Contributing

Please see CONTRIBUTING for details.

Security

If you discover any security related issues, please email freek@spatie.be instead of using the issue tracker.

Credits

• Freek Van der Herten
• All Contributors

The code to execute commands on a remote server was copied from Envoy.

About Spatie

Spatie is a webdesign agency based in Antwerp, Belgium. You'll find an overview of all our open source projects on our website.

License

The MIT License (MIT). Please see License File for more information.