Ping

On this page

  1. Usage

This check will send a request to a given URL. It will report a failure when that URL doesn't respond with a successful response code within a second.

Here's how you can register the check.

use Spatie\Health\Facades\Health;
use Spatie\Health\Checks\Checks\PingCheck;

Health::checks([
    PingCheck::new()->url('https://example.com'),
]);

You can use timeout() to set the maximum number of seconds the HTTP request should run for before the PingCheck fails.

use Spatie\Health\Facades\Health;
use Spatie\Health\Checks\Checks\PingCheck;

Health::checks([
    PingCheck::new()->url('https://example.com')->timeout(2),
]);

You can use name() to change the title of the PingCheck. This is useful when you have multiple PingChecks and you want to distinguish them from each other easily.

use Spatie\Health\Facades\Health;
use Spatie\Health\Checks\Checks\PingCheck;

Health::checks([
    PingCheck::new()->url('https://example.com')->name('Example'),
    PingCheck::new()->url('https://spatie.be')->name('Spatie'),
]);

You can use retryTimes() to set the number of times to retry the PingCheck before failing.

use Spatie\Health\Facades\Health;
use Spatie\Health\Checks\Checks\PingCheck;

Health::checks([
    PingCheck::new()->url('https://example.com')->retryTimes(3),
]);