FPM Health-check CLI

CLI tool for doing Health-Check for PHP-FPM

Add to project

composer require 9gag/fpm-health-check

Usage

CLI / Shell-exec health-checker

Include this in your PHP project, or get it from the Docker image. Then call the bin/fpm-health-check or fpm-health-check.phar from the health checker. It calls FPM via FastCGI without needing a web server. It checks for normal HTTP status code from the server response, and exits with non-zero code on failure.

To evaluate service health with generic health-check endpoint, pass the full path to main PHP script as first argument, and the URL path as second argument.

./bin/fpm-health-check run --fail-on-empty -- /app/public/index.php /v1/health-check.json

It also takes an option to perform additional check for FPM status. To check FPM status, use the status path (pm.status_path) as the first argument

./bin/fpm-health-check run --check-fpm-status -- /_/_/status

HTTP based health-checker

You will first need to make FPM status available via HTTP (You will probably want it on a private port). Then take the fpm-health-check.fcgi.php and make it available to the health-checker. The FCGI script makes call to the FPM status page, parses it and determines service health.

Configure the script via environment variables - FPM_STATUS_PATH, FPM_HTTP_HOST, FPM_HTTP_PORT.

Reference

Original idea from wizaplace/php-fpm-status-cli