Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/gritzkoo/php-health-checker
simple PHP package to test integrations and expose liveness and readiness checks
https://github.com/gritzkoo/php-health-checker
health-check healthcheck healthchecks k8s liveness php readiness
Last synced: 3 months ago
JSON representation
simple PHP package to test integrations and expose liveness and readiness checks
- Host: GitHub
- URL: https://github.com/gritzkoo/php-health-checker
- Owner: gritzkoo
- License: mit
- Created: 2022-06-25T04:35:48.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2022-06-26T22:39:51.000Z (over 2 years ago)
- Last Synced: 2024-06-19T07:10:06.819Z (7 months ago)
- Topics: health-check, healthcheck, healthchecks, k8s, liveness, php, readiness
- Language: PHP
- Homepage: https://packagist.org/packages/gritzkoo/php-health-checker
- Size: 1.1 MB
- Stars: 3
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# PHP Health Checker
[](https://github.com/gritzkoo/php-health-checker/actions/workflows/test.yml)
[](https://coveralls.io/github/gritzkoo/php-health-checker?branch=main)
___
This is a PHP package that allows you to track the health of your application, providing two **_methods_** of checking `$checkt->liveness()` and `$checker->readiness()`:
## How to install
```sh
composer require gritzkoo/php-health-checker
```
## Bootstrapping the checker
```php
'My application name',
// version is used in liveness and readiness actions
'version' => 'v1.0.0', // more details in version section of this document!
// the list of checks you whant to test, is just an array of array with name and handle function
'integrations' => [
[
// the name of the integration you are trying to verify
'name' => 'github status check',
// here is just an example of how to make your own check
// you can inject this function the way you want, you only need to return
// a instance of Gritzkoo\HealthChecker\Check
// The HealthCheker will interpret your check fails when the $check->error is not empty
'handle' => function () {
$check = new Check([
'url' => 'https://github.com/status'
]);
$ch = curl_init($check->url);
try {
$response = curl_exec($ch);
} catch (Exception $e) {
$check->error = $e;
}
$info = curl_getinfo($ch);
curl_close($ch);
if ($info['http_code'] != 200) {
$check->error = [
'response' => $response,
'info' => $info
];
}
return $check;
}
]
]
]);
```
## Example of use
You can view this full Laravel application, with this package installed in:
[https://github.com/gritzkoo/php-health-checker-example-app](https://github.com/gritzkoo/php-health-checker-example-app)
___
## $checker->liveness()
Will return an **_ARRAY_** that you can convert to **_JSON_** as below and that allows you to check if your application is _OK_ without checking any kind of integration.
```json
{
"status": "fully functional",
"version": "v1.0.0"
}
```
___
## $checker->readiness()
Will return an **_ARRAY_** that you can convert to **_JSON_** as below and that allows you to check if your application is up and running and check if all of your integrations informed in the configuration list are up and running.
```json
{
"name": "My application name",
"version": "v1.0.0",
// the main status checks, will return true when all integrations does not fail
"status": true,
// ISO 8601 date
"date": "2022-06-25T11:52:56-03:00",
"duration": 0.08681011199951172,
"integrations": [
{
"name": "github status check",
"status": true,
"response_time": 0.08406686782836914,
"url": "https://github.com/status",
"error": null
}
]
}
```
## Create a HTTP inteface to expose probs
>Using Laravel application example
Once you create an instance of `Gritzkoo\HealthChecker\HealthChecker` you should create 2 routes in your application to expose `liveness` and `readiness` actions like:
- Controller
- Route
And then, you could call these endpoints manually to see your application health, but, if you are using modern Kubernetes deployment, you can config your chart to check your application with the setup below:
```yaml
apiVersion: v1
kind: Pod
metadata:
labels:
test: liveness
name: liveness-http
spec:
containers:
- name: liveness
image: 'node' #your application image
args:
- /server
livenessProbe:
httpGet:
path: /health-check/liveness
port: 80
httpHeaders:
- name: Custom-Header
value: Awesome
initialDelaySeconds: 3
periodSeconds: 3
- name: readiness
image: 'node' #your application image
args:
- /server
readinessProbe:
httpGet:
path: /health-check/readiness
port: 80
httpHeaders:
- name: Custom-Header
value: Awesome
initialDelaySeconds: 3
periodSeconds: 3
```