Laravel Health

https://github.com/spatie/laravel-health
Admin
A package for Laravel that allows you to monitor the health of your application by registering...
Tokens:27,390
Snippets:307
Trust Score:10
License:MIT
Update:1 month ago
Show doc for...
Tokens:
Raw
### Install spatie/cpu-load-health-check via Composer

Source: https://github.com/spatie/laravel-health/blob/main/docs/available-checks/cpu-load.md

Install the required package using Composer.

```bash
composer require spatie/cpu-load-health-check
```

--------------------------------

### Install spatie/laravel-health via Composer

Source: https://github.com/spatie/laravel-health/blob/main/docs/installation-setup.md

Installs the Laravel Health package via Composer.

```bash
composer require spatie/laravel-health
```

--------------------------------

### Install doctrine/dbal

Source: https://github.com/spatie/laravel-health/blob/main/docs/available-checks/db-size-check.md

Install the doctrine/dbal package, which is required for the database size check to work.

```bash
composer require doctrine/dbal
```

--------------------------------

### Install spatie/security-advisories-health-check via Composer

Source: https://github.com/spatie/laravel-health/blob/main/docs/available-checks/security-advisories.md

Install the check package using Composer. Run this in the root of your project before using the check.

```bash
composer require spatie/security-advisories-health-check
```

--------------------------------

### Example check with status and notifications

Source: https://github.com/spatie/laravel-health/blob/main/docs/basic-usage/creating-custom-checks.md

This example check monitors disk usage and sends a warning notification above 70% and a failed notification above 90%. It uses the getDiskUsagePercentage method (omitted for brevity).

```php
namespace App\Checks;

use Spatie\Health\Checks\Check;
use Spatie\Health\Checks\Result;

class UsedDiskSpaceCheck extends Check
{
    public function run(): Result
    {
        $usedDiskSpacePercentage = $this->getDiskUsagePercentage();

        $result = Result::make();

        if ($usedDiskSpacePercentage > 90) {
            return $result->failed("The disk is almost full ({$usedDiskSpacePercentage} % used)");
        }

        if ($usedDiskSpacePercentage > 70) {
            return $result->warning("The disk getting full ({$usedDiskSpacePercentage}% used)");
        }

        return $result->ok();
    }

    protected function getDiskUsagePercentage(): int
    {
        // determine used disk space, omitted for brevity
    }
}
```

--------------------------------

### Install Slack Notification Channel

Source: https://github.com/spatie/laravel-health/blob/main/docs/configuring-notifications/via-slack.md

Install the Slack notification channel package required to use the Slack channel for health check notifications.

```bash
composer require laravel/slack-notification-channel
```

--------------------------------

### Example JSON content of health results

Source: https://github.com/spatie/laravel-health/blob/main/docs/storing-results/in-a-json-file.md

Example of the JSON file content. It contains 'finishedAt' (datetime when all checks finished) and 'checkResults' (array of check results with name, message, status, and meta).

```json
{
    "finishedAt": "2021-01-01 12:25:12",
    "checkResults": [
        {
            "name": "UsedDiskSpace",
            "message": "The disk getting full ({$usedDiskSpacePercentage}% used)",
            "status": "warning",
            "meta": {
                "disk_space_used_percentage": 75
            }
        }
    ]
}
```

--------------------------------

### Register SecurityAdvisoriesCheck in health checks

Source: https://github.com/spatie/laravel-health/blob/main/docs/available-checks/security-advisories.md

Register the SecurityAdvisoriesCheck class in the Health::checks array. The check passes if no security advisories are found for installed packages.

```php
use Spatie\Health\Facades\Health;
use Spatie\SecurityAdvisoriesHealthCheck\SecurityAdvisoriesCheck;

Health::checks([
    SecurityAdvisoriesCheck::new(),
]);
```

--------------------------------

### Customize QueueCheck failure time with failWhenHealthJobTakesLongerThanMinutes

Source: https://github.com/spatie/laravel-health/blob/main/docs/available-checks/queue.md

Customize the number of minutes before the QueueCheck fails. By default it fails after 5 minutes; this example sets it to 10 minutes.

```php
QueueCheck::new()->failWhenHealthJobTakesLongerThanMinutes(10),
```

--------------------------------

### Modify checks conditionally with when

Source: https://github.com/spatie/laravel-health/blob/main/docs/basic-usage/conditionally-running-or-modifying-checks.md

Use the `when` method to alter a check's configuration under a specific condition. In this example, a smaller memory limit is enforced on a local environment.

```php
use Spatie\Health\Facades\Health;
use Spatie\Health\Checks\Checks\RedisMemoryUsageCheck;

Health::checks([
    RedisMemoryUsageCheck::new()
        ->failWhenAboveMb(1000)
        ->when(
            app()->environment('local'), 
            fn (RedisMemoryUsageCheck $check) => $check->failWhenAboveMb(200)
        ),
]);
```

--------------------------------

### Specify minimum backup size with atLeastSizeInMb

Source: https://github.com/spatie/laravel-health/blob/main/docs/available-checks/backups.md

Specifies a minimum size of 20 MB for backups. Only backups larger than this size are considered valid.

```php
use Spatie\Health\Facades\Health;
use Spatie\Health\Checks\Checks\BackupsCheck;

Health::checks([
    BackupsCheck::new()
        ->locatedAt('/path/to/backups/*.zip')
        ->atLeastSizeInMb(20),
]);
```

--------------------------------

### Register UsedDiskSpaceCheck

Source: https://github.com/spatie/laravel-health/blob/main/docs/available-checks/used-disk-space.md

Registers the UsedDiskSpaceCheck with default thresholds: warning at 70% and failure at 90% used disk space.

```php
use Spatie\Health\Facades\Health;
use Spatie\Health\Checks\Checks\UsedDiskSpaceCheck;

Health::checks([
    UsedDiskSpaceCheck::new(),
]);
```

--------------------------------

### Set check frequency with daily()

Source: https://github.com/spatie/laravel-health/blob/main/docs/basic-usage/registering-your-first-check.md

Configures the UsedDiskSpaceCheck to run daily using the daily() method, while DatabaseCheck runs with the default frequency.

```php
Health::checks([
    UsedDiskSpaceCheck::new()->daily(),
    DatabaseCheck::new(),
]);
```

--------------------------------

### Cache config, routes, and events with artisan commands

Source: https://github.com/spatie/laravel-health/blob/main/docs/available-checks/cached-config-routes-and-events.md

Commands to add to your deployment procedure if the OptimizedAppCheck fails. The first caches config and routes, the second caches events.

```bash
php artisan optimize # will cache config and routes
php artisan event:cache # will cache events
```

--------------------------------

### Customize PingCheck cache store with useCacheStore()

Source: https://github.com/spatie/laravel-health/blob/main/docs/available-checks/ping.md

Specifies a different cache store for the failAfterMinutes feature using the useCacheStore() method. The feature relies on cache to write a timestamp of the first failure.

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

Health::checks([
    PingCheck::new()
        ->url('https://example.com')
        ->failAfterMinutes(5)
        ->useCacheStore('your-custom-store-name'),
]);
```

--------------------------------

### Customize expected environment with expectEnvironment

Source: https://github.com/spatie/laravel-health/blob/main/docs/available-checks/environment.md

Customizes the expected environment to 'staging' by calling expectEnvironment on the check instance.

```php
EnvironmentCheck::new()->expectEnvironment('staging'),
```

--------------------------------

### BackupsCheck::new()->atLeastSizeInMb()

Source: https://github.com/spatie/laravel-health/blob/main/docs/available-checks/backups.md

Specifies a minimum size for the backups.

```APIDOC
## BackupsCheck::new()->atLeastSizeInMb()

### Description
Specifies a minimum size for the backups. Only backups larger than the specified size will be considered valid.

### Method
N/A (PHP class method)

### Endpoint
N/A

### Parameters
#### Method Parameters
- **sizeInMb** (int) - Required - The minimum size in megabytes.

### Request Example
```php
use Spatie\Health\Facades\Health;
use Spatie\Health\Checks\Checks\BackupsCheck;

Health::checks([
    BackupsCheck::new()
        ->locatedAt('/path/to/backups/*.zip')
        ->atLeastSizeInMb(20),
]);
```

### Response
#### Success Response
- **Health check result** - The check result indicating whether backups meet the minimum size requirement.

#### Response Example
N/A
```

--------------------------------

### Specify cache driver with driver()

Source: https://github.com/spatie/laravel-health/blob/main/docs/available-checks/cache.md

Checks a specific cache driver by calling the driver() method with the driver name. Replace 'another-cache-driver' with your desired cache driver.

```php
CacheCheck::new()->driver('another-cache-driver'),
```

--------------------------------

### Set timezone and daily time with timezone() and dailyAt()

Source: https://github.com/spatie/laravel-health/blob/main/docs/basic-usage/registering-your-first-check.md

Sets a custom timezone for UsedDiskSpaceCheck and a daily time for both checks. UsedDiskSpaceCheck runs at 2AM Los Angeles time, DatabaseCheck at 2AM UTC.

```php
Health::checks([
    UsedDiskSpaceCheck::new()->dailyAt('02:00')->timezone('America/Los_Angeles'),
    DatabaseCheck::new()->dailyAt('02:00'),
]);
```

--------------------------------

### Run tests with composer test

Source: https://github.com/spatie/laravel-health/blob/main/README.md

Runs the package's test suite.

```bash
composer test
```

--------------------------------

### BackupsCheck::new()->onDisk()

Source: https://github.com/spatie/laravel-health/blob/main/docs/available-checks/backups.md

Specifies a Laravel disk for the backups check.

```APIDOC
## BackupsCheck::new()->onDisk()

### Description
Specifies any disk you have configured in Laravel. Useful when backups are stored on an external filesystem.

### Method
N/A (PHP class method)

### Endpoint
N/A

### Parameters
#### Method Parameters
- **disk** (string) - Required - The name of the Laravel disk.

### Request Example
```php
use Spatie\Health\Facades\Health;
use Spatie\Health\Checks\Checks\BackupsCheck;

Health::checks([
    BackupsCheck::new()
        ->onDisk('backups')
        ->locatedAt('backups'),
]);
```

### Response
#### Success Response
- **Health check result** - The check result indicating whether backups on the specified disk are up to date.

#### Response Example
N/A
```

--------------------------------

### Configure Ping URL via .env

Source: https://github.com/spatie/laravel-health/blob/main/docs/available-checks/schedule.md

Configures the ping URL via environment variable.

```APIDOC
## Configure Ping URL via .env

### Description
Sets the heartbeat URL via environment variable for external monitoring.

### Method
N/A (Configuration)

### Endpoint
N/A

### Parameters
- **SCHEDULE_HEARTBEAT_URL** (string) - Required - The URL to ping when the schedule is running.

### Request Example
```env
SCHEDULE_HEARTBEAT_URL=https://your-monitoring-service.com/ping/abc123
```

### Response
N/A
```

--------------------------------

### Ignore multiple packages with ignoredPackages

Source: https://github.com/spatie/laravel-health/blob/main/docs/available-checks/security-advisories.md

Use the ignoredPackages method to ignore multiple packages at once. Pass an array of package names to exclude them from the security check.

```php
Health::checks([
    SecurityAdvisoriesCheck::new()->ignoredPackages([
       'spatie/laravel-backup',
       'spatie/laravel-medialibrary',
   ]),
]);
```

--------------------------------

### Delay failure with failAfterMinutes

Source: https://github.com/spatie/laravel-health/blob/main/docs/available-checks/horizon.md

Delays failure status for the specified minutes. Reports a warning first, then transitions to failed if Horizon remains unreachable for the duration.

```php
Health::checks([
    HorizonCheck::new()
        ->failAfterMinutes(3),
]);
```

--------------------------------

### Register QueueCheck with default options

Source: https://github.com/spatie/laravel-health/blob/main/docs/available-checks/queue.md

Register a QueueCheck with default options. It monitors the 'default' queue and fails if the job dispatched by DispatchQueueCheckJobsCommand isn't handled within 5 minutes.

```php
use Spatie\Health\Facades\Health;
use Spatie\Health\Checks\Checks\QueueCheck;

Health::checks([
    QueueCheck::new(),
]);
```

--------------------------------

### Publish and run health migrations

Source: https://github.com/spatie/laravel-health/blob/main/docs/installation-setup.md

Publishes and runs the migration that creates the health_check_result_history_items table for the EloquentHealthResultStore. Not needed when using the JsonFileResultStore.

```bash
php artisan vendor:publish --tag="health-migrations"
php artisan migrate
```

--------------------------------

### Register HorizonCheck

Source: https://github.com/spatie/laravel-health/blob/main/docs/available-checks/horizon.md

Registers the HorizonCheck to verify that Horizon is running. Reports a warning when paused and a failure when not running.

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

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

--------------------------------

### Publish health config file

Source: https://github.com/spatie/laravel-health/blob/main/docs/configuring-notifications/via-oh-dear.md

Run this artisan command to publish the health configuration file so you can edit the oh_dear_endpoint settings.

```bash
php artisan vendor:publish --tag="health-config"
```

--------------------------------

### Check youngest backup age with youngestBackShouldHaveBeenMadeBefore

Source: https://github.com/spatie/laravel-health/blob/main/docs/available-checks/backups.md

Ensures the most recent backup is not older than 1 day using the youngestBackShouldHaveBeenMadeBefore method.

```php
use Spatie\Health\Facades\Health;
use Spatie\Health\Checks\Checks\BackupsCheck;

Health::checks([
    BackupsCheck::new()
        ->locatedAt('/path/to/backups/*.zip')
        ->youngestBackShouldHaveBeenMadeBefore(now()->subDays(1)),
]);
```

--------------------------------

### Customize UsedDiskSpaceCheck thresholds

Source: https://github.com/spatie/laravel-health/blob/main/docs/available-checks/used-disk-space.md

Customizes the warning and failure thresholds for used disk space percentage using the methods warnWhenUsedSpaceIsAbovePercentage and failWhenUsedSpaceIsAbovePercentage.

```php
UsedDiskSpaceCheck::new()
    ->warnWhenUsedSpaceIsAbovePercentage(60)
    ->failWhenUsedSpaceIsAbovePercentage(80),
```

--------------------------------

### Register DatabaseConnectionCountCheck with warning and fail thresholds

Source: https://github.com/spatie/laravel-health/blob/main/docs/available-checks/db-connection-count.md

Register the check with both a warning threshold of 50 and a failure threshold of 100 connections.

```php
use Spatie\Health\Facades\Health;
use Spatie\Health\Checks\Checks\DatabaseConnectionCountCheck;

Health::checks([
    DatabaseConnectionCountCheck::new()
        ->warnWhenMoreConnectionsThan(50)
        ->failWhenMoreConnectionsThan(100)
]);
```

--------------------------------

### Configure pingTimeout and pingRetryTimes

Source: https://github.com/spatie/laravel-health/blob/main/docs/available-checks/horizon.md

Configures ping timeout and retry times. Defaults are 3 seconds and 1 retry. Failed pings are logged to the application log.

```php
Health::checks([
    HorizonCheck::new()
        ->pingTimeout(5)    // Set timeout in seconds (default: 3)
        ->pingRetryTimes(3) // Set number of retry attempts (default: 1)
]);
```

--------------------------------

### Register BackupCheck with locatedAt

Source: https://github.com/spatie/laravel-health/blob/main/docs/available-checks/backups.md

Registers the BackupCheck with a glob pattern to locate backup zip files. The locatedAt method accepts a glob pattern.

```php
use Spatie\Health\Facades\Health;
use Spatie\Health\Checks\Checks\BackupsCheck;

Health::checks([
    BackupsCheck::new()->locatedAt('/path/to/backups/*.zip'),
]);
```

--------------------------------

### Run checks before listing with the --fresh option

Source: https://github.com/spatie/laravel-health/blob/main/docs/viewing-results/on-the-cli.md

First executes all checks to ensure fresh results are displayed, then lists the outcomes. Add `--fresh` to the `health:list` command.

```bash
php artisan health:list --fresh
```

--------------------------------

### Use HorizonCheck with .env heartbeat URL

Source: https://github.com/spatie/laravel-health/blob/main/docs/available-checks/horizon.md

Uses the HorizonCheck with the heartbeat URL from the .env file. The URL is pinged automatically when the check passes.

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

--------------------------------

### BackupsCheck::new()->locatedAt()

Source: https://github.com/spatie/laravel-health/blob/main/docs/available-checks/backups.md

Registers a BackupsCheck and specifies the backup directory using a glob pattern.

```APIDOC
## BackupsCheck::new()->locatedAt()

### Description
Registers a BackupsCheck that verifies backups are up to date. The `locatedAt` method specifies the directory where backups are stored, accepting a glob pattern.

### Method
N/A (PHP class method)

### Endpoint
N/A

### Parameters
#### Method Parameters
- **locatedAt** (string) - Required - The directory path or glob pattern where backup files are stored.

### Request Example
```php
use Spatie\Health\Facades\Health;
use Spatie\Health\Checks\Checks\BackupsCheck;

Health::checks([
    BackupsCheck::new()->locatedAt('/path/to/backups/*.zip'),
]);
```

### Response
#### Success Response
- **Health check result** - The check result indicating whether backups are up to date.

#### Response Example
N/A
```

--------------------------------

### Check backups on external filesystem with onDisk

Source: https://github.com/spatie/laravel-health/blob/main/docs/available-checks/backups.md

Checks backups on an external filesystem by specifying a configured Laravel disk with the onDisk method.

```php
use Spatie\Health\Facades\Health;
use Spatie\Health\Checks\Checks\BackupsCheck;

Health::checks([
    BackupsCheck::new()
        ->onDisk('backups')
        ->locatedAt('backups'),
]);
```

--------------------------------

### Check number of backups with numberOfBackups

Source: https://github.com/spatie/laravel-health/blob/main/docs/available-checks/backups.md

Checks that the number of backups is between 5 and 10. The numberOfBackups method accepts min and/or max parameters.

```php
use Spatie\Health\Facades\Health;
use Spatie\Health\Checks\Checks\BackupsCheck;

Health::checks([
    BackupsCheck::new()->locatedAt('/path/to/backups/*.zip')->numberOfBackups(min: 5, max: 10),
]);
```

--------------------------------

### Register DatabaseConnectionCountCheck with fail threshold

Source: https://github.com/spatie/laravel-health/blob/main/docs/available-checks/db-connection-count.md

Register the DatabaseConnectionCountCheck and set a failure threshold of 100 connections.

```php
use Spatie\Health\Facades\Health;
use Spatie\Health\Checks\Checks\DatabaseConnectionCountCheck;

Health::checks([
    DatabaseConnectionCountCheck::new()
        ->failWhenMoreConnectionsThan(100)
]);
```

--------------------------------

### Register CpuLoadCheck with failWhenLoadIsHigherInTheLast5Minutes and failWhenLoadIsHigherInTheLast15Minutes

Source: https://github.com/spatie/laravel-health/blob/main/docs/available-checks/cpu-load.md

Register the CPU load check in the health check list. The check fails when the load in the last 5 minutes is higher than 2.0 or the load in the last 15 minutes is higher than 1.5.

```php
use Spatie\Health\Facades\Health;
use Spatie\CpuLoadHealthCheck\CpuLoadCheck;

Health::checks([
    CpuLoadCheck::new()
        ->failWhenLoadIsHigherInTheLast5Minutes(2.0)
        ->failWhenLoadIsHigherInTheLast15Minutes(1.5),
]);
```

--------------------------------

### Default health config file with result stores and notifications

Source: https://github.com/spatie/laravel-health/blob/main/docs/installation-setup.md

Default configuration for result stores, notifications, Oh Dear endpoint, theme, and queue job silencing. The Eloquent result store is enabled with 5-day history; alternative stores are commented out. Notifications throttle to one per hour by default.

```php
return [

    /*
     * A result store is responsible for saving the results of the checks. The
     * `EloquentHealthResultStore` will save results in the database. You
     * can use multiple stores at the same time.
     */
    'result_stores' => [
        Spatie\Health\ResultStores\EloquentHealthResultStore::class => [
            'model' => Spatie\Health\Models\HealthCheckResultHistoryItem::class,
            'keep_history_for_days' => 5,
        ],

        /*
        Spatie\Health\ResultStores\CacheHealthResultStore::class => [
            'store' => 'file',
        ],

        Spatie\Health\ResultStores\JsonFileHealthResultStore::class => [
            'disk' => 's3',
            'path' => 'health.json',
        ],

        Spatie\Health\ResultStores\InMemoryHealthResultStore::class,
        */
    ],

    /*
     * You can get notified when specific events occur. Out of the box you can use 'mail' and 'slack'.
     * For Slack you need to install laravel/slack-notification-channel.
     */
    'notifications' => [
        /*
         * Notifications will only get sent if this option is set to `true`.
         */
        'enabled' => true,

        'notifications' => [
            Spatie\Health\Notifications\CheckFailedNotification::class => ['mail'],
        ],

        /*
         * Here you can specify the notifiable to which the notifications should be sent. The default
         * notifiable will use the variables specified in this config file.
         */
        'notifiable' => Spatie\Health\Notifications\Notifiable::class,

        /*
         * When checks start failing, you could potentially end up getting
         * a notification every minute.
         *
         * With this setting, notifications are throttled. By default, you'll
         * only get one notification per hour.
         */
        'throttle_notifications_for_minutes' => 60,
        
        /*
         * When set to true, notifications will only be sent when at least one
         * check has a 'failed' status. Warnings will be ignored.
         */
        'only_on_failure' => false,

        'mail' => [
            'to' => 'your@example.com',

            'from' => [
                'address' => env('MAIL_FROM_ADDRESS', 'hello@example.com'),
                'name' => env('MAIL_FROM_NAME', 'Example'),
            ],
        ],

        'slack' => [
            'webhook_url' => env('HEALTH_SLACK_WEBHOOK_URL', ''),

            /*
             * If this is set to null the default channel of the webhook will be used.
             */
            'channel' => null,

            'username' => null,

            'icon' => null,
        ],
    ],

    /*
     * You can let Oh Dear monitor the results of all health checks. This way, you'll
     * get notified of any problems even if your application goes totally down. Via
     * Oh Dear, you can also have access to more advanced notification options.
     */
    'oh_dear_endpoint' => [
        'enabled' => false,

        /*
         * When this option is enabled, the checks will run before sending a response.
         * Otherwise, we'll send the results from the last time the checks have run.
         */
        'always_send_fresh_results' => true,

        /*
         * The secret that is displayed at the Application Health settings at Oh Dear.
         */
        'secret' => env('OH_DEAR_HEALTH_CHECK_SECRET'),

        /*
         * The URL that should be configured in the Application health settings at Oh Dear.
         */
        'url' => '/oh-dear-health-check-results',
    ],

    /*
     * You can set a theme for the local status page
     *
     * - light: light mode
     * - dark: dark mode
     */
    'theme' => 'light',
    
    /*
     * When enabled,  completed `HealthQueueJob`s will be displayed 
     * in Horizon's silenced jobs screen.
     */
    'silence_health_queue_job' => true,
];
```

--------------------------------

### Check oldest backup age with oldestBackShouldHaveBeenMadeAfter

Source: https://github.com/spatie/laravel-health/blob/main/docs/available-checks/backups.md

Ensures the oldest backup is older than 1 week using the oldestBackShouldHaveBeenMadeAfter method.

```php
use Spatie\Health\Facades\Health;
use Spatie\Health\Checks\Checks\BackupsCheck;

Health::checks([
    BackupsCheck::new()
        ->locatedAt('/path/to/backups/*.zip')
        ->oldestBackShouldHaveBeenMadeAfter(now()->subWeeks(1)),
]);
```

--------------------------------

### Configure JsonFileHealthResultStore in health config

Source: https://github.com/spatie/laravel-health/blob/main/docs/storing-results/in-a-json-file.md

Configure the result store in the 'health_stores' key of the health config file. The 'disk' key can be set to any disk from config/filesystems.php, e.g., 's3', and 'path' specifies the file location.

```php
return [
    'result_stores' => [
        JsonFileHealthResultStore::class => [
            'disk' => 's3',
            'path' => 'health.json',
        ],
    ],
];
```

--------------------------------

### Setting result status methods

Source: https://github.com/spatie/laravel-health/blob/main/docs/basic-usage/creating-custom-checks.md

The Result object has methods to set the status: ok(), warning(), and failed(). Passing a string to these methods triggers a notification.

```php
$result = Spatie\Health\Checks\Result::make();

$result->ok(); // the check ran ok
$result->warning(); // the check ran ok, but with a warning
$result->failed(); // the check failed
```

--------------------------------

### Register QueueCheck with onQueue for multiple queues

Source: https://github.com/spatie/laravel-health/blob/main/docs/available-checks/queue.md

Register a QueueCheck that monitors multiple queues by passing an array to the onQueue method.

```php
use Spatie\Health\Facades\Health;
use Spatie\Health\Checks\Checks\QueueCheck;

Health::checks([
    QueueCheck::new()->onQueue(['email', 'payment']),
]);
```

--------------------------------

### Use InMemoryHealthResultStore

Source: https://github.com/spatie/laravel-health/blob/main/docs/configuring-notifications/via-oh-dear.md

Set result_stores to InMemoryHealthResultStore to avoid storing health results locally.

```php
// in app/config/health.php

'result_stores' => [
     Spatie\Health\ResultStores\InMemoryHealthResultStore::class,
],
```

--------------------------------

### Customize cache store for ScheduleCheck

Source: https://github.com/spatie/laravel-health/blob/main/docs/available-checks/schedule.md

Use a dedicated cache store for the schedule check. This is recommended because the check relies on cache and using a dedicated store avoids interference from other cache usage.

```php
use Spatie\Health\Facades\Health;
use Spatie\Health\Checks\Checks\ScheduleCheck;

Health::checks([
    ScheduleCheck::new()->useCacheStore('your-custom-store-name'),
]);
```

--------------------------------

### Configure heartbeat URL via .env

Source: https://github.com/spatie/laravel-health/blob/main/docs/available-checks/schedule.md

Set the URL that will be pinged whenever the schedule check passes. The ping is only sent when the health checks run via the ScheduleCheckHeartbeatCommand at the configured frequency, and only if the check passes.

```env
SCHEDULE_HEARTBEAT_URL=https://your-monitoring-service.com/ping/abc123
```

--------------------------------

### Register UsedDiskSpaceCheck with thresholds

Source: https://github.com/spatie/laravel-health/blob/main/README.md

Registers a UsedDiskSpaceCheck to monitor disk space. Sends a warning notification when usage exceeds 70% and an error notification above 90%. Typically placed in a service provider.

```php
// typically, in a service provider

use Spatie\Health\Facades\Health;
use Spatie\Health\Checks\Checks\UsedDiskSpaceCheck;

Health::checks([
    UsedDiskSpaceCheck::new()
        ->warnWhenUsedSpaceIsAbovePercentage(70)
        ->failWhenUsedSpaceIsAbovePercentage(90),
]);
```

--------------------------------

### Configure result_stores with InMemoryHealthResultStore

Source: https://github.com/spatie/laravel-health/blob/main/docs/storing-results/not-storing-results.md

Set the 'result_stores' key in the health config file to use Spatie\Health\ResultStores\InMemoryHealthResultStore to avoid persisting results. This is useful when you only trigger results via HTTP or JSON endpoints.

```php
return [
    'result_stores' => [
        Spatie\Health\ResultStores\InMemoryHealthResultStore::class,
    ],
```

--------------------------------

### Avoid storing results and notifications with --do-not-store-results and --no-notification

Source: https://github.com/spatie/laravel-health/blob/main/docs/viewing-results/on-the-cli.md

When using the `--fresh` option, these additional options prevent storing results and sending notifications. Useful for one-off checks without side effects.

```bash
php artisan health:list --fresh --do-not-store-results --no-notification
```

--------------------------------

### Run checks with fresh query parameter

Source: https://github.com/spatie/laravel-health/blob/main/docs/viewing-results/as-json.md

Add the 'fresh' query parameter to run the checks in the same request and see the latest results in the JSON response.

```text
https://example.com/health?fresh
```

--------------------------------

### Check a different database connection with connectionName

Source: https://github.com/spatie/laravel-health/blob/main/docs/available-checks/db-size-check.md

Specify a different database connection to check by calling connectionName() before setting the size threshold.

```php
DatabaseSizeCheck::new()->connectionName('another-connection-name')->failWhenSizeAboveGb(5.0),
```

--------------------------------

### Registering duplicate PingCheck without unique names (fails)

Source: https://github.com/spatie/laravel-health/blob/main/docs/basic-usage/registering-the-same-check-multiple-times.md

Attempts to register two PingCheck instances without unique names. This will throw an exception because each check name must be unique; by default the name is the base class name.

```php
// ⛔️ this will not work

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

Health::checks([
    PingCheck::new()->url('https://your-site.com'),
    PingCheck::new()->url('https://another-site.com'),
]);
```

--------------------------------

### Register RedisMemoryUsageCheck with thresholds

Source: https://github.com/spatie/laravel-health/blob/main/docs/available-checks/redis-memory-usage.md

Registers the RedisMemoryUsageCheck with warning and failure thresholds in megabytes. The check fails when memory usage exceeds the fail threshold.

```php
use Spatie\Health\Facades\Health;
use Spatie\Health\Checks\Checks\RedisMemoryUsageCheck;

Health::checks([
    RedisMemoryUsageCheck::new()
        ->warnWhenAboveMb(900)
        ->failWhenAboveMb(1000),
]);
```

--------------------------------

### Specify database connection with connectionName()

Source: https://github.com/spatie/laravel-health/blob/main/docs/available-checks/db-table-size-check.md

Specify a different database connection for the check by calling connectionName().

```php
DatabaseTableSizeCheck::new()->connectionName('another-connection-name'),
```

--------------------------------

### Register DatabaseSizeCheck with failWhenSizeAboveGb

Source: https://github.com/spatie/laravel-health/blob/main/docs/available-checks/db-size-check.md

Register the DatabaseSizeCheck in the health checks list. The check fails when the database size exceeds the specified threshold of 5.0 GB.

```php
use Spatie\Health\Facades\Health;
use Spatie\Health\Checks\Checks\DatabaseSizeCheck;

Health::checks([
    DatabaseSizeCheck::new()
        ->failWhenSizeAboveGb(errorThresholdGb: 5.0)
]);
```

--------------------------------

### Ignore a single package with ignorePackage

Source: https://github.com/spatie/laravel-health/blob/main/docs/available-checks/security-advisories.md

Use the ignorePackage method to exclude a specific package from the security check. The check will not fail for the ignored package.

```php
Health::checks([
    SecurityAdvisoriesCheck::new()->ignorePackage('spatie/laravel-backup'),
]);
```

--------------------------------

### Register QueueCheck with onQueue for a single queue

Source: https://github.com/spatie/laravel-health/blob/main/docs/available-checks/queue.md

Register a QueueCheck that monitors a different queue by using the onQueue method with a single queue name.

```php
use Spatie\Health\Facades\Health;
use Spatie\Health\Checks\Checks\QueueCheck;

Health::checks([
    QueueCheck::new()->onQueue('email'),
]);
```

--------------------------------

### Default oh_dear_endpoint configuration

Source: https://github.com/spatie/laravel-health/blob/main/docs/configuring-notifications/via-oh-dear.md

Default values for the oh_dear_endpoint key in the published health config file. Set enabled to true, add a secret (recommended in .env), and optionally customize the url.

```php
// in app/config/health.php

/*
 * You can let Oh Dear monitor the results of all health checks. This way, you'll
 * get notified of any problems even if your application goes totally down. Via
 * Oh Dear, you can also have access to more advanced notification options.
 */
'oh_dear_endpoint' => [
    'enabled' => false,

    /*
     * When this option is enabled, the checks will run before sending a response.
     * Otherwise, we'll send the results from the last time the checks have run.
     */
    'always_send_fresh_results' => true,

    /*
     * The secret that is displayed at the Application Health settings at Oh Dear.
     */
    'secret' => env('OH_DEAR_HEALTH_CHECK_SECRET'),

    /*
     * The URL that should be configured in the Application health settings at Oh Dear.
     */
    'url' => '/oh-dear-health-check-results',
],
```

--------------------------------

### Check only config and routes with OptimizedAppCheck

Source: https://github.com/spatie/laravel-health/blob/main/docs/available-checks/cached-config-routes-and-events.md

Registers OptimizedAppCheck to only check that config and routes are cached, using the checkConfig and checkRoutes methods. Events are not checked.

```php
use Spatie\Health\Facades\Health;
use Spatie\Health\Checks\Checks\OptimizedAppCheck;

Health::checks([
    OptimizedAppCheck::new()
       ->checkConfig()
       ->checkRoutes(),
]);
```

--------------------------------

### Customize error thresholds with warnWhenMoreErrorsReceivedThan and failWhenMoreErrorsReceivedThan

Source: https://github.com/spatie/laravel-health/blob/main/docs/available-checks/flare-error-count.md

Customizes the error thresholds for the Flare check. Use warnWhenMoreErrorsReceivedThan and failWhenMoreErrorsReceivedThan to set the number of errors that trigger a warning or failure, respectively.

```php
FlareErrorOccurrenceCountCheck::new()
    ->warnWhenMoreErrorsReceivedThan(20)
    ->failWhenMoreErrorsReceivedThan(50),
```

--------------------------------

### Delay PingCheck failure with failAfterMinutes()

Source: https://github.com/spatie/laravel-health/blob/main/docs/available-checks/ping.md

Delays the failure status by a specified number of minutes. The check first reports a warning when the URL becomes unreachable, and only transitions to failed if it remains unreachable for the specified duration.

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

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

--------------------------------

### Register QueueCheck with custom cache store

Source: https://github.com/spatie/laravel-health/blob/main/docs/available-checks/queue.md

Register a QueueCheck with a custom cache store. The check relies on cache; the test job writes a timestamp that QueueCheck verifies.

```php
use Spatie\Health\Facades\Health;
use Spatie\Health\Checks\Checks\QueueCheck;

Health::checks([
    QueueCheck::new()->useCacheStore('your-custom-store-name'),
]);
```

--------------------------------

### Optimize external filesystem checks with parseModifiedFormat and onlyCheckSizeOnFirstAndLast

Source: https://github.com/spatie/laravel-health/blob/main/docs/available-checks/backups.md

Optimizes checks on external filesystems by parsing the modified date from the filename and limiting size checks to the first and last backup files. This can speed up checks of ~200 files on S3 from about 30 seconds to about 1 second.

```php
use Spatie\Health\Facades\Health;
use Spatie\Health\Checks\Checks\BackupsCheck;

Health::checks([
    BackupsCheck::new()
        ->onDisk('backups')
        ->parseModifiedFormat('Y-m-d_H-i-s')
        ->atLeastSizeInMb(20)
        ->onlyCheckSizeOnFirstAndLast(),
]);
```

--------------------------------

### Register PingCheck with URL

Source: https://github.com/spatie/laravel-health/blob/main/docs/available-checks/ping.md

Registers a PingCheck that sends a request to the given URL. The check fails if the URL doesn't respond with a successful response code within a second.

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

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

--------------------------------

### BackupsCheck::new()->youngestBackShouldHaveBeenMadeBefore()

Source: https://github.com/spatie/laravel-health/blob/main/docs/available-checks/backups.md

Checks if the youngest backup was made before a certain date.

```APIDOC
## BackupsCheck::new()->youngestBackShouldHaveBeenMadeBefore()

### Description
Checks if the youngest backup was made before a certain date. Ensures the most recent backup is not older than the specified date.

### Method
N/A (PHP class method)

### Endpoint
N/A

### Parameters
#### Method Parameters
- **date** (Carbon\Carbon) - Required - The date before which the youngest backup should have been made.

### Request Example
```php
use Spatie\Health\Facades\Health;
use Spatie\Health\Checks\Checks\BackupsCheck;

Health::checks([
    BackupsCheck::new()
        ->locatedAt('/path/to/backups/*.zip')
        ->youngestBackShouldHaveBeenMadeBefore(now()->subDays(1)),
]);
```

### Response
#### Success Response
- **Health check result** - The check result indicating whether the youngest backup is before the specified date.

#### Response Example
N/A
```

--------------------------------

### BackupsCheck::new()->onlyCheckSizeOnFirstAndLast()

Source: https://github.com/spatie/laravel-health/blob/main/docs/available-checks/backups.md

Limits the size check to only the first and last backup files for performance.

```APIDOC
## BackupsCheck::new()->onlyCheckSizeOnFirstAndLast()

### Description
Limits the size check to only the first and last backup files. Otherwise the check needs to reach out to all files and check the file sizes.

### Method
N/A (PHP class method)

### Endpoint
N/A

### Parameters
#### Method Parameters
None

### Request Example
```php
use Spatie\Health\Facades\Health;
use Spatie\Health\Checks\Checks\BackupsCheck;

Health::checks([
    BackupsCheck::new()
        ->onDisk('backups')
        ->parseModifiedFormat('Y-m-d_H-i-s')
        ->atLeastSizeInMb(20)
        ->onlyCheckSizeOnFirstAndLast(),
]);
```

### Response
#### Success Response
- **Health check result** - The check result indicating whether backups are up to date.

#### Response Example
N/A
```

--------------------------------

### Customize PingCheck retry times with retryTimes()

Source: https://github.com/spatie/laravel-health/blob/main/docs/available-checks/ping.md

Sets the number of times to retry the PingCheck before failing using the retryTimes() method.

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

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

--------------------------------

### Render health check results on a webpage

Source: https://github.com/spatie/laravel-health/blob/main/docs/viewing-results/on-a-webpage.md

Registers a route that renders the latest health check results using the package's controller. The controller is referenced by class name and the route is defined on any URL you desire. Ensure authorization is handled if the results should not be public.

```php
use Spatie\Health\Http\Controllers\HealthCheckResultsController;

Route::get('health', HealthCheckResultsController::class);
```

--------------------------------

### Register OptimizedAppCheck

Source: https://github.com/spatie/laravel-health/blob/main/docs/available-checks/cached-config-routes-and-events.md

Registers the OptimizedAppCheck to verify that config, routes, and events are cached. The check passes if all three are cached.

```php
use Spatie\Health\Facades\Health;
use Spatie\Health\Checks\Checks\OptimizedAppCheck;

Health::checks([
    OptimizedAppCheck::new(),
]);
```

--------------------------------

### Customize PingCheck timeout in milliseconds with timeoutMs()

Source: https://github.com/spatie/laravel-health/blob/main/docs/available-checks/ping.md

Sets the timeout in milliseconds for the HTTP request using the timeoutMs() method for more precise control.

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

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

--------------------------------

### Customize Cache Store

Source: https://github.com/spatie/laravel-health/blob/main/docs/available-checks/schedule.md

Configures the ScheduleCheck to use a custom cache store.

```APIDOC
## Customize Cache Store

### Description
Configures the ScheduleCheck to use a custom cache store.

### Method
N/A (Configuration)

### Endpoint
N/A

### Parameters
- **cacheStore** (string) - Required - The name of the custom cache store.

### Request Example
```php
use Spatie\Health\Facades\Health;
use Spatie\Health\Checks\Checks\ScheduleCheck;

Health::checks([
    ScheduleCheck::new()->useCacheStore('your-custom-store-name'),
]);
```

### Response
N/A
```

--------------------------------

### Register EnvironmentCheck

Source: https://github.com/spatie/laravel-health/blob/main/docs/available-checks/environment.md

Registers the EnvironmentCheck in the health checks list. By default, the check fails when the application environment is not 'production'.

```php
use Spatie\Health\Facades\Health;
use Spatie\Health\Checks\Checks\EnvironmentCheck;

Health::checks([
    EnvironmentCheck::new(),
]);
```

--------------------------------

### Register checks with Health::checks()

Source: https://github.com/spatie/laravel-health/blob/main/docs/basic-usage/registering-your-first-check.md

Registers the UsedDiskSpaceCheck and DatabaseCheck checks by passing an array to Health::checks(). Typically placed in a service provider.

```php
// typically, in a service provider

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

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

--------------------------------

### Adding meta information

Source: https://github.com/spatie/laravel-health/blob/main/docs/basic-usage/creating-custom-checks.md

You can add meta information to a result using the meta method with an array. This meta information is stored and can be used by external services like Oh Dear.

```php
namespace App\Checks;

use Spatie\Health\Checks\Check;
use Spatie\Health\Checks\Result;

class UsedDiskSpaceCheck extends Check
{
    public function run(): Result
    {
        $usedDiskSpacePercentage = $this->getDiskUsagePercentage();

        $result = Result::make();
        
        $result->meta(['used_disk_space' => $usedDiskSpacePercentage]);
        
        // rest of the check omitted for brevity
        
        return $result;
    }
}
```

--------------------------------

### Return a non-zero exit code on failing check with --fail-command-on-failing-check

Source: https://github.com/spatie/laravel-health/blob/main/docs/viewing-results/on-the-cli.md

By default, the command returns a zero exit status even if some check is failing. Add this option to make the command return a non-zero exit code when a check fails.

```bash
php artisan health:list --fail-command-on-failing-check
```

--------------------------------

### BackupsCheck::new()->numberOfBackups()

Source: https://github.com/spatie/laravel-health/blob/main/docs/available-checks/backups.md

Checks if the number of backups is within a specified range.

```APIDOC
## BackupsCheck::new()->numberOfBackups()

### Description
Checks if the number of backups is within a specified range. Accepts a `min` and/or a `max` parameter.

### Method
N/A (PHP class method)

### Endpoint
N/A

### Parameters
#### Method Parameters
- **min** (int) - Optional - Minimum number of backups allowed.
- **max** (int) - Optional - Maximum number of backups allowed.

### Request Example
```php
use Spatie\Health\Facades\Health;
use Spatie\Health\Checks\Checks\BackupsCheck;

Health::checks([
    BackupsCheck::new()->locatedAt('/path/to/backups/*.zip')->numberOfBackups(min: 5, max: 10),
]);
```

### Response
#### Success Response
- **Health check result** - The check result indicating whether the number of backups is within the specified range.

#### Response Example
N/A
```

--------------------------------

### Customize PingCheck timeout with timeout()

Source: https://github.com/spatie/laravel-health/blob/main/docs/available-checks/ping.md

Sets the maximum number of seconds the HTTP request should run before the PingCheck fails using the timeout() method.

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

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

--------------------------------

### Registering multiple PingCheck instances with unique names

Source: https://github.com/spatie/laravel-health/blob/main/docs/basic-usage/registering-the-same-check-multiple-times.md

Registers two PingCheck instances with unique names using the name method. This overrides the default base class name and allows multiple checks of the same type.

```php
// 👍 this will work

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

Health::checks([
    PingCheck::new()->name('Your site ping check')->url('https://your-site.com'),
    PingCheck::new()->name('Another site ping check')->url('https://another-site.com'),
]);
```

--------------------------------

### Configure Slack Settings in health.php

Source: https://github.com/spatie/laravel-health/blob/main/docs/configuring-notifications/via-slack.md

Configure Slack settings in the health config file. Set the HEALTH_SLACK_WEBHOOK_URL environment variable to a valid Slack webhook URL. The channel, username, and icon are optional; if channel is null, the webhook's default channel is used.

```php
// in config/health.php

'slack' => [
    'webhook_url' => env('HEALTH_SLACK_WEBHOOK_URL', ''),

    /*
     * If this is set to null the default channel of the webhook will be used.
     */
    'channel' => null,

    'username' => null,

    'icon' => null,
],
```

--------------------------------

### Configure EloquentHealthResultStore in health config

Source: https://github.com/spatie/laravel-health/blob/main/docs/storing-results/in-the-database.md

Configure the EloquentHealthResultStore in the health config file under the 'result_stores' key. Results are written to the 'health_check_result_history_items' table.

```php
return [
    'result_stores' => [
        EloquentHealthResultStore::class,
    ],
];
```

--------------------------------

### Configure only_on_failure in config/health.php

Source: https://github.com/spatie/laravel-health/blob/main/docs/configuring-notifications/general.md

Enable the only_on_failure option in the health config file to receive notifications only when checks have a failed status, ignoring warnings. This is useful when you want to reduce notification noise.

```php
// in config/health.php

'notifications' => [
    'enabled' => true,
    'only_on_failure' => true, // only notify on failed checks, ignore warnings
    // ...
],
```

--------------------------------

### Configure custom model for EloquentHealthResultStore

Source: https://github.com/spatie/laravel-health/blob/main/docs/storing-results/in-the-database.md

Use a custom model by extending Spatie\Health\Models\HealthCheckResultHistoryItem and specifying it in the EloquentHealthResultStore configuration.

```php
return [
    'result_stores' => [
        Spatie\Health\ResultStores\EloquentHealthResultStore::class => [
            'model' => App\Models\CustomHealthCheckResultModel::class,
        ],
    ],
];
```

--------------------------------

### Schedule model:prune for HealthCheckResultHistoryItem

Source: https://github.com/spatie/laravel-health/blob/main/docs/storing-results/in-the-database.md

Schedule the model:prune command daily to prune health check result history items. The model class must be explicitly added when it is not in the App namespace.

```php
// in routes/console.php
use Illuminate\Support\Facades\Schedule;

Schedule::command('model:prune', ['--model' => [\Spatie\Health\Models\HealthCheckResultHistoryItem::class]])->daily();
```

--------------------------------

### Configure CacheHealthResultStore in health config

Source: https://github.com/spatie/laravel-health/blob/main/docs/storing-results/in-cache.md

Configure the CacheHealthResultStore in the health config file under the 'health_stores' key. The 'store' key can be set to any of the stores configured in config/cache.php.

```php
return [
    'result_stores' => [
        CacheHealthResultStore::class => [
            'store' => 'file',
        ],
    ],
];
```

--------------------------------

### View all health check results with php artisan health:list

Source: https://github.com/spatie/laravel-health/blob/main/docs/viewing-results/on-the-cli.md

Displays the results of all checks. By default, if some check is failing, the command returns a zero exit status. Use this command to view the current results.

```bash
php artisan health:list
```

--------------------------------

### Schedule the heartbeat command every minute

Source: https://github.com/spatie/laravel-health/blob/main/docs/available-checks/schedule.md

Schedule the heartbeat command to run every minute. Place it as the very last command in your schedule. This command writes the current timestamp to the cache for the ScheduleCheck.

```php
// in app/Console/Kernel.php
use \Spatie\Health\Commands\ScheduleCheckHeartbeatCommand;

public function schedule(Schedule $schedule) {
    // your other commands

    $schedule->command(ScheduleCheckHeartbeatCommand::class)->everyMinute();
}
```

--------------------------------

### Register DatabaseTableSizeCheck

Source: https://github.com/spatie/laravel-health/blob/main/docs/available-checks/db-table-size-check.md

Register the DatabaseTableSizeCheck with the Health facade, specifying table names and their maximum sizes in megabytes. The check fails if any table exceeds its maximum size.

```php
use Spatie\Health\Facades\Health;
use Spatie\Health\Checks\Checks\DatabaseTableSizeCheck;

Health::checks([
    DatabaseTableSizeCheck::new()
        ->table('your_table_name', maxSizeInMb: 1_000)
        ->table('another_table_name', maxSizeInMb: 2_000),
]);
```

--------------------------------

### Add authorization header to MeilisearchCheck

Source: https://github.com/spatie/laravel-health/blob/main/docs/available-checks/meilisearch.md

Uses the token() method to add an authorization header to the request.

```php
use Spatie\Health\Facades\Health;
use Spatie\Health\Checks\Checks\MeilisearchCheck;

Health::checks([
    MeilisearchCheck::new()->token('auth-token'),
]);
```

--------------------------------

### Customize PingCheck cache key prefix with cacheKeyPrefix()

Source: https://github.com/spatie/laravel-health/blob/main/docs/available-checks/ping.md

Customizes the prefix used for the cache key using the cacheKeyPrefix() method. The default prefix is 'health:checks:ping'.

```php
PingCheck::new()
    ->url('https://example.com')
    ->failAfterMinutes(5)
    ->cacheKeyPrefix('my-app:health:ping'),
```
Tokens:
Raw