Laravel Health

In addition to the built-in checks, you can extend your application's monitoring capabilities using third-party health check packages. These are community-maintained packages designed to work with laravel-health.

Examples of third-party checks include:

• Domain Expiry Health Check
• Env vars
• SSL certificate expiration
• Laravel Octane
• Memory Usage Check
• Queue Size Check
• Opcache Check

The laravel-health package provides a variety of built-in checks to monitor different aspects of your application's infrastructure and configuration. You can register any of these checks to verify the health of your application.

Built-in checks include:

• Application & Environment: Application Cache, Debug Mode, Environment, Security advisories.
• Infrastructure & Resources: CPU Load, Used Disk Space, Redis, Meilisearch.
• Database: Database Connection, Database Connection Count, Database Table Size.
• Laravel Ecosystem: Backups, Flare Error Count, Horizon, Queue, Schedule.
• Connectivity: Ping.

You can configure a heartbeat URL to be pinged automatically whenever the health checks run (via RunHealthChecksCommand) if the Horizon check passes. This is useful for external monitoring services like Oh Dear, Pingdom, or Envoyer.

Note: The URL is only pinged if the check passes. The ping is independent of the check's status; the check might pass while the ping fails (e.g., due to a malformed URL).

HORIZON_HEARTBEAT_URL=https://your-monitoring-service.com/ping/abc123

The DatabaseCheck ensures your application can successfully connect to a database. By default, it attempts to connect using your application's default database connection. If the default connection fails, the check will fail.

To use this check, register it within the Health::checks() method.

use Spatie\Health\Facades\Health;
use Spatie\Health\Checks\Checks\DatabaseCheck;

Health::checks([
    DatabaseCheck::new(),
]);

You can use Spatie\Health\ResultStores\CacheHealthResultStore to write the latest health check results to your application's cache. This is useful for persisting check results across different requests or processes.

To configure this, add the CacheHealthResultStore class to the result_stores array within the health configuration file. You must specify which cache driver to use via the store key. The value for store must match one of the cache stores defined in your config/cache.php file (e.g., file, redis, database).

return [
    'result_stores' => [
        CacheHealthResultStore::class => [
            'store' => 'file', // Replace 'file' with your configured cache store name
        ],
    ],
];

By default, the HealthCheckResultsController renders the latest cached results. If you want to force the checks to run during the current request so you see real-time results, append the fresh query parameter to the URL.

https://example.com/health?fresh

To receive Slack notifications when health checks return warnings or failures, you must first install the official Laravel Slack notification channel via Composer.

composer require laravel/slack-notification-channel

The HorizonCheck ensures that Laravel Horizon is running. It reports a warning if Horizon is paused and a failure if Horizon is not running at all.

To use it, register the check within your Health::checks() call.

use Spatie\Health\Facades\Health;
use Spatie\Health\Checks\Checks\HorizonCheck;

Health::checks([
    HorizonCheck::new(),
]);

The HealthCheckJsonResultsController returns a detailed JSON view of all executed health checks, including their individual statuses and metadata.

Note: This endpoint always returns a 200 status code unless a critical error occurs. Because it exposes detailed internal information, it is highly recommended to protect this route with authentication middleware.

Route::middleware('auth')->get('health', \Spatie\Health\Http\Controllers\HealthCheckJsonResultsController::class);