Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/beyondcode/laravel-self-diagnosis
Perform Self-Diagnosis Tests On Your Laravel Application
https://github.com/beyondcode/laravel-self-diagnosis
Last synced: 30 days ago
JSON representation
Perform Self-Diagnosis Tests On Your Laravel Application
- Host: GitHub
- URL: https://github.com/beyondcode/laravel-self-diagnosis
- Owner: beyondcode
- License: mit
- Created: 2018-07-04T15:43:10.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-03-14T15:55:52.000Z (8 months ago)
- Last Synced: 2024-09-30T15:41:01.587Z (about 1 month ago)
- Language: PHP
- Size: 170 KB
- Stars: 1,419
- Watchers: 25
- Forks: 111
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Perform Self-Diagnosis Tests On Your Laravel Application
[](https://packagist.org/packages/beyondcode/laravel-self-diagnosis)
[](https://packagist.org/packages/beyondcode/laravel-self-diagnosis)
This package allows you to run self-diagnosis tests on your Laravel application. It comes with multiple checks out of the box and allows you to add custom checks yourself.
Here is an example output of the command:
## Included checks
- Is the APP_KEY set?
- Are your composer dependencies up to date with the composer.lock file?
- Do you have the correct PHP version installed?
- Do you have the correct PHP extensions installed?
- Can a connection to the database be established?
- Do the `storage` and `bootstrap/cache` directories have the correct permissions?
- Does the `.env` file exist?
- Is the maintenance mode disabled?
- Are the required locales installed on the system?
- Are there environment variables that exist in `.env.example` but not in `.env`?
- Are there any migrations that need to be run?
- Is the storage directory linked?
- Can Redis be accessed?
### Development environment checks
- Is the configuration not cached?
- Are the routes not cached?
- Are there environment variables that exist in `.env` but not in `.env.example`?
### Production environment checks
- Is the configuration cached?
- Are the routes cached?
- Is the xdebug PHP extension disabled?
- Is APP_DEBUG set to false?
- Are certain servers reachable?
- Are certain supervisor programs running?
## Installation
You can install the package via composer:
```bash
composer require beyondcode/laravel-self-diagnosis
```
## Usage
Just call the artisan command to start the checks:
```bash
php artisan self-diagnosis
```
### Customization
You can publish the configuration file, that contains all available checks using:
```bash
php artisan vendor:publish --provider=BeyondCode\\SelfDiagnosis\\SelfDiagnosisServiceProvider
```
This will publish a `self-diagnosis.php` file in your `config` folder. This file contains all the checks that will be performed on your application.
```php
[
'prod' => 'production',
'live' => 'production',
'local' => 'development',
],
/*
* Common checks that will be performed on all environments.
*/
'checks' => [
\BeyondCode\SelfDiagnosis\Checks\AppKeyIsSet::class,
\BeyondCode\SelfDiagnosis\Checks\CorrectPhpVersionIsInstalled::class,
\BeyondCode\SelfDiagnosis\Checks\DatabaseCanBeAccessed::class => [
'default_connection' => true,
'connections' => [],
],
\BeyondCode\SelfDiagnosis\Checks\DirectoriesHaveCorrectPermissions::class => [
'directories' => [
storage_path(),
base_path('bootstrap/cache'),
],
],
\BeyondCode\SelfDiagnosis\Checks\EnvFileExists::class,
\BeyondCode\SelfDiagnosis\Checks\ExampleEnvironmentVariablesAreSet::class,
\BeyondCode\SelfDiagnosis\Checks\LocalesAreInstalled::class => [
'required_locales' => [
'en_US',
'en_US.utf8',
],
],
\BeyondCode\SelfDiagnosis\Checks\MaintenanceModeNotEnabled::class,
\BeyondCode\SelfDiagnosis\Checks\MigrationsAreUpToDate::class,
\BeyondCode\SelfDiagnosis\Checks\PhpExtensionsAreInstalled::class => [
'extensions' => [
'openssl',
'PDO',
'mbstring',
'tokenizer',
'xml',
'ctype',
'json',
],
'include_composer_extensions' => true,
],
\BeyondCode\SelfDiagnosis\Checks\StorageDirectoryIsLinked::class,
],
/*
* Environment specific checks that will only be performed for the corresponding environment.
*/
'environment_checks' => [
'development' => [
\BeyondCode\SelfDiagnosis\Checks\ComposerWithDevDependenciesIsUpToDate::class => [
'additional_options' => '--ignore-platform-reqs',
],
\BeyondCode\SelfDiagnosis\Checks\ConfigurationIsNotCached::class,
\BeyondCode\SelfDiagnosis\Checks\RoutesAreNotCached::class,
],
'production' => [
\BeyondCode\SelfDiagnosis\Checks\ComposerWithoutDevDependenciesIsUpToDate::class => [
'additional_options' => '--ignore-platform-reqs',
],
\BeyondCode\SelfDiagnosis\Checks\ConfigurationIsCached::class,
\BeyondCode\SelfDiagnosis\Checks\DebugModeIsNotEnabled::class,
\BeyondCode\SelfDiagnosis\Checks\PhpExtensionsAreDisabled::class => [
'extensions' => [
'xdebug',
],
],
\BeyondCode\SelfDiagnosis\Checks\RedisCanBeAccessed::class => [
'default_connection' => true,
'connections' => [],
],
\BeyondCode\SelfDiagnosis\Checks\RoutesAreCached::class,
\BeyondCode\SelfDiagnosis\Checks\ServersArePingable::class => [
'servers' => [
'www.google.com',
['host' => 'www.google.com', 'port' => 8080],
'8.8.8.8',
['host' => '8.8.8.8', 'port' => 8080, 'timeout' => 5],
],
],
\BeyondCode\SelfDiagnosis\Checks\SupervisorProgramsAreRunning::class => [
'programs' => [
'horizon',
],
'restarted_within' => 300, // max seconds since last restart, 0 to disable check
],
],
],
];
```
#### Available Configuration Options
The following options are available for the individual checks:
- [`BeyondCode\SelfDiagnosis\Checks\ComposerWithDevDependenciesIsUpToDate`](src/Checks/ComposerWithDevDependenciesIsUpToDate.php)
- **additional_options** *(string, optional parameters like `'--ignore-platform-reqs'`)*: optional arguments for composer
- [`BeyondCode\SelfDiagnosis\Checks\ComposerWithoutDevDependenciesIsUpToDate`](src/Checks/ComposerWithoutDevDependenciesIsUpToDate.php)
- **additional_options** *(string, optional parameters like `'--ignore-platform-reqs'`)*: optional arguments for composer
- [`BeyondCode\SelfDiagnosis\Checks\DatabaseCanBeAccessed`](src/Checks/DatabaseCanBeAccessed.php)
- **default_connection** *(boolean, default: `true`)*: if the default connection should be checked
- **connections** *(array, list of connection names like `['mysql', 'sqlsrv']`, default: `[]`)*: additional connections to check
- [`BeyondCode\SelfDiagnosis\Checks\DirectoriesHaveCorrectPermissions`](src/Checks/DirectoriesHaveCorrectPermissions.php)
- **directories** *(array, list of directory paths like `[storage_path(), base_path('bootstrap/cache')]`, default: `[]`)*: directories to check
- [`BeyondCode\SelfDiagnosis\Checks\LocalesAreInstalled`](src/Checks/LocalesAreInstalled.php)
- **required_locales** *(array, list of locales like `['en_US', 'en_US.utf8']`, default: `[]`)*: locales to check
- [`BeyondCode\SelfDiagnosis\Checks\PhpExtensionsAreDisabled`](src/Checks/PhpExtensionsAreDisabled.php)
- **extensions** *(array, list of extension names like `['xdebug', 'zlib']`, default: `[]`)*: extensions to check
- [`BeyondCode\SelfDiagnosis\Checks\PhpExtensionsAreInstalled`](src/Checks/PhpExtensionsAreInstalled.php)
- **extensions** *(array, list of extension names like `['openssl', 'PDO']`, default: `[]`)*: extensions to check
- **include_composer_extensions** *(boolean, default: `false`)*: if required extensions defined in `composer.json` should be checked
- [`BeyondCode\SelfDiagnosis\Checks\RedisCanBeAccessed`](src/Checks/RedisCanBeAccessed.php)
- **default_connection** *(boolean, default: `true`)*: if the default connection should be checked
- **connections** *(array, list of connection names like `['cache_1', 'cache_2']`, default: `[]`)*: additional connections to check
- [`BeyondCode\SelfDiagnosis\Checks\SupervisorProgramsAreRunning`](src/Checks/SupervisorProgramsAreRunning.php)
- **programs** *(array, list of programs like `['horizon', 'another-program']`, default: `[]`)*: programs that are required to be running
- **restarted_within** *(integer, max allowed seconds since last restart of programs (`0` = disabled), default: `0`)*: verifies that programs have been restarted recently to grab code updates
- [`BeyondCode\SelfDiagnosis\Checks\ServersArePingable`](src/Checks/ServersArePingable.php)
- **servers** *(array, list of servers and parameters like `['google.com', ['host' => 'google.com', 'port' => 8080]]`)*: servers to ping
### Custom Checks
You can create custom checks, by implementing the [`BeyondCode\SelfDiagnosis\Checks\Check`](src/Checks/Check.php) interface and adding the class to the config file.
Like this:
```php