Download the PHP package letsgoi/laravel-health-check without Composer
On this page you can find all versions of the php package letsgoi/laravel-health-check. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download letsgoi/laravel-health-check
More information about letsgoi/laravel-health-check
Files in letsgoi/laravel-health-check
Package laravel-health-check
Short Description Laravel health checker
License MIT
Homepage https://github.com/letsgoi/laravel-health-check
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package laravel-health-check
Laravel Health Check
Package to perform health check analysis based on defined checkers.
Requirements
- PHP >= 8.3
- Laravel >= 10.0
Instalation
-
Require package with composer:
- Publish configuration:
Service Provider will be automatically registered, however if you want to add it manually, you must add this to your config/app.php file:
Configuration
You must set all checkers that want to pass your application at checkers array on config file (config/laravel_health_check.php):
You can check any checker without check all, but this configuration is for general check.
Usage
Check individual checker
Use HealthCheck facade to check an individual checker:
it will return true if check pass and it will throw HealthCheckerException if not.
Check all checkers defined at configuration file
To check all checkers defined at configuration file use healthCheck method of HealthCheck facade:
it will return true if all checks pass and throw HealthCheckerException with failed checkers if not.
Get check errors
If you want to get all check errors of checkers defined at configuration file, you can use getCheckErrors method:
It returns an array with all errors.
HealthCheck command
You can run the healthcheck with artisan command:
It show ok if all checks pass or exceptions if fails.
HealthCheck endpoint
You can configure an endpoint to check the health of your app. Configure it on config file (laravel_health_check):
It will return the ok message if all check passed or a server error with the array of errors.
Checkers
Available checkers
Those are the available predefined checkers:
Letsgoi\HealthCheck\Checkers\AppKeyChecker: Checks if there is an app key defined as environment variable.Letsgoi\HealthCheck\Checkers\DatabaseConnectionChecker: Checks if the app can connect with default database connection.Letsgoi\HealthCheck\Checkers\DatabaseMigrationsChecker: Checks if all migrations are up to date.Letsgoi\HealthCheck\Checkers\DebugChecker: Checks if the app is not on debug mode.Letsgoi\HealthCheck\Checkers\EnvFileChecker: Checks if there is an .env file.Letsgoi\HealthCheck\Checkers\WritablePathsChecker: Checks if the necessary paths are writable.
Custom checkers
If you need some custom checker (or someone not available yet, PRs are welcome :)), you can do simply implementing the Letsgoi\HealthCheck\Contracts\HealthChecker contract.
It forces to implement a check method that returns true if check pass or false if not.
Then you can use normally adding to your config file or checking it with individual mode.
Testing
Run tests:
Contributing
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
Please make sure to update tests as appropriate.
License
MIT
