From 8b1b7a3e7f82fafc3987c01340b00ce494281bb9 Mon Sep 17 00:00:00 2001 From: David <75451291+dulkoss@users.noreply.github.com> Date: Sun, 4 Feb 2024 19:28:42 +0100 Subject: [PATCH] update the list of available checks --- README.md | 69 ++++++++++++++++++++++++++++++++++++++++++------------- 1 file changed, 53 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index 4347961..a695033 100644 --- a/README.md +++ b/README.md @@ -90,30 +90,71 @@ php artisan ok:check ## Available checks -✅ **Cache Check**: Check if reading and writing to the cache is possible. +**Cache Check**: Check whether reading and writing to the cache is possible. -✅ **Composer Audit Check**: Checks if there are any security vulnerabilities in your composer dependencies. +**Composer Outdated Check**: Checks whether there are outdated packages in your project and informs you of the findings. -✅ **Config Cache Check**: Checks if the config is cached. +**Composer Audit Check**: Checks whether there are any security vulnerabilities in your composer dependencies. -✅ **Debug Mode Check**: Checks if debug mode is enabled. +**CPU Load Check**: Checks whether the total CPU load is above a certain percentage on a short, mid and long term. -✅ **Disk Space Check**: Checks if the disk space is below a certain threshold. +**Config Cache Check**: Checks whether the config is cached. -✅ **Environment Check**: Checks if the current environment matches the given environment. +**Database Check**: Checks whether a connection can be established on the configured connection. -✅ **Event Cache Check**: Checks if events are cached. +**Database Connection Count Check**: Checks whether the database's connection count exceeds a configurable limit. -✅ **Horizon Check**: Checks if Horizon is running. +**Database Size Check**: Checks whether the database's data exceeds a configurable size limit. -✅ **NPM Audit Check**: Checks if there are any security vulnerabilities in your npm dependencies. +**Database Table Size Check**: Does the same as the Database Size Check but for a specific table. -✅ **NPM Installed Package Check**: Checks if a certain npm package is installed. +**Debug Mode Check**: Checks whether debug mode is enabled. -✅ **Queue Check**: Checks if the queue is running. +**Directory Check**: Checks whether the configured directories exist. -✅ **Route Cache Check**: Checks if routes are cached. +**Disk Space Check**: Checks whether the disk space is below a certain threshold. +**DotEnv Check**: Checks whether the configured environment variables are accessible in the application. + +**Environment Check**: Checks whether the current environment matches the configured environment type. + +**Event Cache Check**: Checks whether events are cached. + +**Extension Check**: Checks whether the configured PHP extensions are loaded. + +**File Check**: Does the same as the Directory Check but for files. + +**Horizon Check**: Checks whether Horizon is running. + +**Memory Usage Check**: Checks whether the total memory usage exceeds a configurable limit in the form of a percentage. **(LINUX ONLY)** + +**NPM Audit Check**: Checks whether there are any security vulnerabilities in your npm dependencies. + +**NPM Installed Package Check**: Checks whether a certain npm package is installed. + +**OPCache Check**: Checks whether OP cache and optionally the JIT compiler are configured and running. + +**Permission Check**: Checks whether the configured filesystem items have the correct permissions for the current user. + +**Ping check**: Checks whether the application can ping the specified address, if the address is not specified it defaults to `www.google.com`. + +**Process Count Check**: Checks whether the configured programs are exceeding the configured process count. + +**Queue Check**: Checks whether the queue is running. + +**Reboot Check**: Checks whether the server has rebooted recently. + +**Redis Check**: Checks whether the application can connect to the configured redis connections. + +**Redis Memory Usage Check**: Checks whether the Redis instance is exceeding a configured amount of memory usage. + +**Route Cache Check**: Checks whether routes are cached. + +**Scheduler Check**: Checks whether the scheduler has is still online and running jobs. + +**Storage Check**: Checks whether the configured disks can be written to and read from. + +**UptimeCheck**: Checks whether the server's uptime exceeds a configured maximum. ## Testing @@ -125,10 +166,6 @@ composer test Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently. -## Contributing - -Please see [CONTRIBUTING](CONTRIBUTING.md) for details. - ## Security Vulnerabilities Please review [our security policy](../../security/policy) on how to report security vulnerabilities.