Download the PHP package saritasa/laravel-healthcheck without Composer
On this page you can find all versions of the php package saritasa/laravel-healthcheck. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download saritasa/laravel-healthcheck
More information about saritasa/laravel-healthcheck
Files in saritasa/laravel-healthcheck
Package laravel-healthcheck
Short Description Package for projects health-check
License MIT
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-healthcheck
Laravel Health Check
Package for Laravel-based project self-diagnostics. Implements basic checks (ex. if application can connect to DB server) and allows extensibility (ex. implement custom checks)
Laravel 5.5+
Install the package:
Configuration
- Publish configuration file:
Configure the necessary checks in file config/health_check.php
You can add more custom checks - just add a class implementing
\Saritasa\LaravelHealthCheck\Contracts\ServiceHealthChecker interface with single method check()
that must return instance of \Saritasa\LaravelHealthCheck\Contracts\CheckResult.
Laravel Lumen 8.0+
Install the package:
Create a new file :
Add the service provider in file :
Usage
Package exposes endpoints to run all checks or run each check by name:
GET /health
Runs all known checks and returns HTTP code = 200, if all checks succeeded, 500 otherwise.
Response contains JSON with pares of check name and true/false indicating if checker completed successfully or not.
GET /health/{checker}
Where {checker} is a key from config/health_check.php, ex. GET /health-check/database.
Returns HTTP code = 200, if checker reports success, 500 otherwise.
Returns payload, returned by checker. If check result is not successful, adds error message.
GET /liveness, GET /readness
Do nothing, just check availability of PHP application
Available checkers
Saritasa\LaravelHealthCheck\Checkers\DatabaseHealthChecker
Checks, if default connection to DB, configured in Laravel is available - tries to establish connection to server.
Saritasa\LaravelHealthCheck\Checkers\RedisHealthChecker
Checks, if redis connection is available - tries to establish connection to server.
Saritasa\LaravelHealthCheck\Checkers\S3HealthChecker
Checks, if application can read from default S3 bucket - tries to get enumerate entries in S3 bucket.
Saritasa\LaravelHealthCheck\Checkers\NullChecker
Does nothing. Use if you need to check HTTP server availability only.
Contributing
- Create fork, checkout it
- Develop locally as usual. Code must follow PSR-1, PSR-2 -
run PHP_CodeSniffer to ensure, that code follows style guides - Cover added functionality with unit tests and run PHPUnit to make sure, that all tests pass
- Update README.md to describe new or changed functionality
- Add changes description to Semantic Versioning convention to determine next version number.
- When ready, create pull request
All versions of laravel-healthcheck with dependencies
illuminate/database Version ^5.6 || 6.* || 7.* || 8.* || 9.* || 10.* || 11.*
illuminate/routing Version ^5.6 || 6.* || 7.* || 8.* || 9.* || 10.* || 11.*
illuminate/support Version ^5.6 || 6.* || 7.* || 8.* || 9.* || 10.* || 11.*
saritasa/php-common Version ^1.1