Download the PHP package codete/health-check without Composer
On this page you can find all versions of the php package codete/health-check. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download codete/health-check
More information about codete/health-check
Files in codete/health-check
Package health-check
Short Description Library providing unified way for running application health checks
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 health-check
Purpose
HealthCheck library aims to provide an easy way to write arbitrary system checks that are ran regularly. For library it does not matter what you check, what matters is whether the check result is OK, WARNING or ERROR and how the library can be of help to notify you about the results.
Requirements
Library's only requirement is that you use PHP not older than 7.1. The library also provides few out of the box
integrations, you can check the require-dev section. Also for all Symfony lovers we provide a bundle that will
turn library integration into a breeze.
HealthCheck
Any health check must implement \Codete\HealthCheck\HealthCheck interface. To register your check in the library
you can tag service with hc.health_check tag if you're using Symfony or add it to
\Codete\HealthCheck\HealthCheckRegistry manually.
To fulfill the HealthCheck contract your implementation must provide 2 methods:
getName- human readable name of the checkcheck- actual logic of your check
Additionally the library provides \Codete\HealthCheck\ExpiringHealthCheck which allows you to set an expiry date
for the check. This can prove especially useful for 3rd party API health checks when you know when used version
will no longer be supported. In practice checks that are OK but valid date is due will turn to warnings.
The check method must return \Codete\HealthCheck\HealthStatus object which encapsulates check result (OK,
WARNING or ERROR) and an optional message. Basing on status result Result Handlers can act accordingly.
ResultHandler
Result handler are services that are handling health check results. Any Result handler must implement
\Codete\HealthCheck\ResultHandler interface. To register your handler in the library you can tag service with
hc.result_handler and provide unique id parameter if you're using Symfony or add it to
\Codete\HealthCheck\ResultHandlerRegistry manually. For example implementations you can take a look into
\Codete\HealthCheck\ResultHandler\ namespace.
Commands
Bundle provides two commands:
health-check:run <fqcn>to run one health check and output its statushealth-check:run-allto run all registered health checks and output results in a nice way
