README

A basic package to handle checking different things in Laravel, and reporting on them.

Admin Login Check - Handles logging all logins (only logs time, and user id) automatically
Disk Space Check - Checks for free disk space and total disk space, by default passing is 50% free or higher, partial is 10%-49%, and less than 10% is failed.
HTTP Status Check - Checks to see if the front page of your site is responding with a 200 status code. Option in the config to save the response body, by default it is disabled.
SSL Checker - Checks the SSL status on your application, reports on expiration date, whether it's secure, and more.

Installation

You can install the package via composer:

composer require darkgoldblade01/status-check

Publish the config file:

php artisan vendor:publish --provider="Darkgoldblade01\StatusCheck\StatusCheckServiceProvider"

Migrate the database:

php artisan migrate

Usage

The base package has built in checks for a few key elements. If you would like to create your own checks, you can by just extending the Darkgoldblade01\StatusCheck\Classes\Checker class:

<?php

namespace App\Checks;

use Darkgoldblade01\StatusCheck\Classes\Checker;

/**
 * Class NewChecker
 */
class NewChecker extends Checker
{

    public string $name = 'New Check';

    public function handle(): array
    {
    
        //Required Response
        return [
            'status' => 'passed|partial|failed',
            'results' => string|array|object|int|boolean,
        ];
    }

}

Once created, just add them to the status-check.php config file under the checks.

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 brianldj@gmail.com instead of using the issue tracker.

darkgoldblade01 / status-check

Maintainers

Details