Laravel Health

https://spatie.be/docs/laravel-health/v1
Admin
Laravel Health is a package that monitors the health of your Laravel application by running...
Tokens:24,684
Snippets:550
Trust Score:9.3
Update:6 months ago
Show doc for...
Tokens:
Raw
### Install Security Advisories Check

Source: https://spatie.be/docs/laravel-health/v1/available-checks/security-advisories

Install the package via Composer before usage.

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

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

### Install CPU Load Health Check Package

Source: https://spatie.be/docs/laravel-health/v1/available-checks/cpu-load

Use Composer to install the spatie/cpu-load-health-check package. This is a prerequisite for using the CPU load check.

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

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

### Install doctrine/dbal dependency

Source: https://spatie.be/docs/laravel-health/v1/available-checks/db-connection-count

Required package installation for the database connection check to function.

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

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

### Install Slack Notification Channel

Source: https://spatie.be/docs/laravel-health/v1/configuring-notifications/via-slack

Install the Laravel Slack notification channel package using Composer. This is a prerequisite for sending notifications to Slack.

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

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

### Example Disk Space Health Check

Source: https://spatie.be/docs/laravel-health/v1/basic-usage/creating-custom-checks

A practical implementation of a custom check that returns different statuses based on disk usage thresholds.

```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 Laravel Health via Composer

Source: https://spatie.be/docs/laravel-health/v1/installation-setup

Use this command to add the package to your Laravel project.

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

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

### Register ScheduleCheck

Source: https://spatie.be/docs/laravel-health/v1/available-checks/schedule

Register the ScheduleCheck using the Health facade. This is the basic setup required for the check.

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

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

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

### Example JSON Health Check Results

Source: https://spatie.be/docs/laravel-health/v1/storing-results/in-a-json-file

This is an example of the JSON output generated by the `JsonFileHealthResultStore`. It includes the timestamp when checks finished and the results of individual checks, such as disk space usage.

```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 Default Cache Check

Source: https://spatie.be/docs/laravel-health/v1/available-checks/cache

Register the default CacheCheck to ensure the 'default' cache connection is working. This is the basic setup for the cache health check.

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

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

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

### Deployment Commands for Caching

Source: https://spatie.be/docs/laravel-health/v1/available-checks/cached-config-routes-and-events

Commands to cache config, routes, and events. Run these during deployment if the OptimizedAppCheck fails.

```bash
php artisan optimize # will cache config and routes
```

```bash
php artisan event:cache # will cache events
```

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

### Customizing Disk Space Thresholds

Source: https://spatie.be/docs/laravel-health/v1/available-checks/used-disk-space

Adjust the percentage thresholds for warnings and failures using fluent configuration methods.

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

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

### Publish and Run Health Migrations

Source: https://spatie.be/docs/laravel-health/v1/installation-setup

Publish the migration files for the health check results and then run the database migration to create the necessary tables.

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

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

### Configuring Cache for PingCheck

Source: https://spatie.be/docs/laravel-health/v1/available-checks/ping

Specify a custom cache store and key prefix for tracking failure status.

```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'),
]);
```

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

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

### GET /health - Health Check JSON Results

Source: https://spatie.be/docs/laravel-health/v1/viewing-results/as-json

This endpoint provides the latest health check results in JSON format. By default, it returns a 200 status code. You can append the `fresh` query parameter to run checks in the same request.

```APIDOC
## GET /health

### Description
Retrieves the latest health check results as a JSON response. Appending the `fresh` query parameter will execute the checks immediately for the current request.

### Method
GET

### Endpoint
`/health`

### Query Parameters
- **fresh** (boolean) - Optional - If present, forces the health checks to run for the current request.

### Response
#### Success Response (200)
- **status** (string) - The overall status of the health checks ('ok' or 'not_ok').
- **checks** (array) - An array of individual check results.
  - **name** (string) - The name of the check.
  - **message** (string) - A message associated with the check result.
  - **status** (string) - The status of the individual check ('ok' or 'not_ok').

#### Response Example
```json
{
  "status": "ok",
  "checks": [
    {
      "name": "Database connection",
      "message": "ok",
      "status": "ok"
    },
    {
      "name": "Cache is working",
      "message": "ok",
      "status": "ok"
    }
  ]
}
```

### Configuration
- **health.json_results_failure_status**: Configurable value for the HTTP status code returned when a check fails. Defaults to 200.
```

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

### Specify database connection

Source: https://spatie.be/docs/laravel-health/v1/available-checks/db-table-size-check

Use a non-default database connection for the table size check.

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

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

### Delaying Failure with failAfterMinutes

Source: https://spatie.be/docs/laravel-health/v1/available-checks/ping

Report a warning initially and only transition to a failed status after the specified duration of unreachability.

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

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

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

### Specify minimum backup size

Source: https://spatie.be/docs/laravel-health/v1/available-checks/backups

Ensure backups meet a minimum size requirement in megabytes.

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

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

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

### Publish Health Config

Source: https://spatie.be/docs/laravel-health/v1/configuring-notifications/via-oh-dear

Use this command to publish the health configuration file to your application.

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

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

### Configure Secret Token Environment Variable

Source: https://spatie.be/docs/laravel-health/v1/security/using-secret-token

Define the secret token in your .env file to be used for authentication.

```text
HEALTH_SECRET_TOKEN=your-secret-token
```

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

### Configure Heartbeat URL

Source: https://spatie.be/docs/laravel-health/v1/available-checks/horizon

Configuration for heartbeat pings via environment variables or direct registration.

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

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

```php
Health::checks([
    HorizonCheck::new()
        ->heartbeatUrl('https://your-monitoring-service.com/ping/abc123'),
]);
```

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

### Optimize external filesystem checks

Source: https://spatie.be/docs/laravel-health/v1/available-checks/backups

Use performance optimizations like parsing dates from filenames and limiting size checks to improve speed on high-latency storage.

```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(),
]);
```

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

### Specify database connection

Source: https://spatie.be/docs/laravel-health/v1/available-checks/db-size-check

Configure the check to monitor a specific database connection instead of the default.

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

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

### Register Basic Health Checks

Source: https://spatie.be/docs/laravel-health/v1/basic-usage/registering-your-first-check

Register `UsedDiskSpaceCheck` and `DatabaseCheck` in your service provider. These checks will run when the `RunHealthChecksCommand` is executed.

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

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

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

### Configure Daily Health Check with Specific Time and Timezone

Source: https://spatie.be/docs/laravel-health/v1/basic-usage/registering-your-first-check

Schedule `UsedDiskSpaceCheck` to run daily at 2 AM in 'America/Los_Angeles' timezone. `DatabaseCheck` will run daily at 2 AM UTC.

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

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

### Register Disk Space Check

Source: https://spatie.be/docs/laravel-health/v1/introduction

Use this snippet in a service provider to monitor used disk space. Configure warning and failure thresholds for notifications.

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

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

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

### Schedule Queue Check Command for Laravel 10 and earlier

Source: https://spatie.be/docs/laravel-health/v1/available-checks/queue

Register the dispatch command in the console kernel to run every minute.

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

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

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

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

### Configure Daily Health Check Frequency

Source: https://spatie.be/docs/laravel-health/v1/basic-usage/registering-your-first-check

Set the `UsedDiskSpaceCheck` to run daily. Other checks will use the default frequency unless specified.

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

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

### Customize Cache Store for Queue Check

Source: https://spatie.be/docs/laravel-health/v1/available-checks/queue

Specify a custom cache store for the queue check to use.

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

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

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

### Check backups on external disks

Source: https://spatie.be/docs/laravel-health/v1/available-checks/backups

Configure the check to use a specific Laravel filesystem disk.

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

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

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

### Customizing the Expected Environment

Source: https://spatie.be/docs/laravel-health/v1/available-checks/environment

Use the expectEnvironment method to specify a non-default environment for the check to validate against.

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

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

### List Health Checks with Fresh Results

Source: https://spatie.be/docs/laravel-health/v1/viewing-results/on-the-cli

Execute this command to first run all health checks and then display their fresh results. This ensures you are viewing the most up-to-date status.

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

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

### Register Queue Check

Source: https://spatie.be/docs/laravel-health/v1/available-checks/queue

Register the default queue check to monitor the default queue with a 5-minute timeout.

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

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

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

### List All Health Checks

Source: https://spatie.be/docs/laravel-health/v1/viewing-results/on-the-cli

Run this command to view the results of all configured health checks. This displays the current status without executing any checks.

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

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

### Monitor Specific Queues

Source: https://spatie.be/docs/laravel-health/v1/available-checks/queue

Configure the check to monitor one or multiple specific queues.

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

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

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

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

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

### Registering multiple PingChecks with unique names

Source: https://spatie.be/docs/laravel-health/v1/basic-usage/registering-the-same-check-multiple-times

Use the name() method to differentiate multiple instances of the same check class. Without unique names, the registration will throw an exception.

```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'),
]);
```

```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'),
]);
```

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

### Register BackupsCheck

Source: https://spatie.be/docs/laravel-health/v1/available-checks/backups

Register the BackupsCheck in the Health configuration, specifying the directory path using a glob pattern.

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

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

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

### Implement a Custom Health Check Class

Source: https://spatie.be/docs/laravel-health/v1/basic-usage/creating-custom-checks

Create a new check by extending the Spatie\Health\Checks\Check class and implementing the required run method.

```php
namespace App\Checks;

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

class YourCustomCheck extends Check
{
    public function run(): Result
    {
        // your custom logic...
    }
}
```

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

### Registering the EnvironmentCheck

Source: https://spatie.be/docs/laravel-health/v1/available-checks/environment

Register the check within the Health::checks array to verify the application environment.

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

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

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

### Specify Database Connection for Check

Source: https://spatie.be/docs/laravel-health/v1/available-checks/db-connection

Configure the DatabaseCheck to verify a specific database connection by name using the `connectionName()` method.

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

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

### Modify check configuration conditionally

Source: https://spatie.be/docs/laravel-health/v1/basic-usage/conditionally-running-or-modifying-checks

Use when and doUnless methods to dynamically adjust check settings based on specific conditions.

```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)
        ),
]);
```

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

### Register DatabaseSizeCheck

Source: https://spatie.be/docs/laravel-health/v1/available-checks/db-size-check

Basic registration of the database size check with a specified threshold.

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

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

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

### Configure OptimizedAppCheck for Specific Caches

Source: https://spatie.be/docs/laravel-health/v1/available-checks/cached-config-routes-and-events

Customize the OptimizedAppCheck to only verify specific caches like config and routes. Use `checkConfig()`, `checkRoutes()`, and `checkEvents()` methods.

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

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

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

### Specify Cache Driver for CacheCheck

Source: https://spatie.be/docs/laravel-health/v1/available-checks/cache

Configure the CacheCheck to verify a specific cache driver other than the default. Use the `driver()` method to specify the desired cache connection name.

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

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

### Oh Dear Endpoint Configuration

Source: https://spatie.be/docs/laravel-health/v1/configuring-notifications/via-oh-dear

Default configuration for the Oh Dear endpoint in the health config file. Set 'enabled' to true and provide a 'secret' for Oh Dear to connect.

```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',
]
```

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

### Register MeilisearchCheck

Source: https://spatie.be/docs/laravel-health/v1/available-checks/meilisearch.md

Register the basic MeilisearchCheck to verify if Meilisearch is running. Ensure Meilisearch is accessible at its default URL.

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

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

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

### Configure Slack Settings

Source: https://spatie.be/docs/laravel-health/v1/configuring-notifications/via-slack

Configure Slack-specific settings in `config/health.php`, including the webhook URL, channel, username, and icon. Ensure the `HEALTH_SLACK_WEBHOOK_URL` environment variable is set.

```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,
],
```

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

### Specify database connection

Source: https://spatie.be/docs/laravel-health/v1/available-checks/db-connection-count

Use the connectionName method to target a specific database connection.

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

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

### Use In-Memory Result Store

Source: https://spatie.be/docs/laravel-health/v1/configuring-notifications/via-oh-dear

Configure 'result_stores' to use InMemoryHealthResultStore if you do not want to store health check results locally.

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

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

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

### Schedule Queue Check Command for Laravel 11 and newer

Source: https://spatie.be/docs/laravel-health/v1/available-checks/queue

Register the dispatch command in the console routes file to run every minute.

```php
// in routes/console.php

use Illuminate\Support\Facades\Schedule;
use Spatie\Health\Commands\DispatchQueueCheckJobsCommand;

// your other scheduled commands

Schedule::command(DispatchQueueCheckJobsCommand::class)->everyMinute();
```

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

### Register DatabaseCheck

Source: https://spatie.be/docs/laravel-health/v1/available-checks/db-connection

Register the default DatabaseCheck to verify the 'default' database connection. Ensure the Health facade and DatabaseCheck class are imported.

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

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

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

### Registering the Redis check

Source: https://spatie.be/docs/laravel-health/v1/available-checks/redis

Register the RedisCheck within the Health::checks array to monitor the default Redis connection.

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

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

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

### Avoid Storing Results

Source: https://spatie.be/docs/laravel-health/v1/basic-usage/manually-running-checks

Use the `--do-not-store-results` option to prevent the results of a manual run from being stored.

```bash
php artisan health:check --do-not-store-results
```

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

### Register Security Advisories Check

Source: https://spatie.be/docs/laravel-health/v1/available-checks/security-advisories

Register the check in the Health configuration file.

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

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

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

### Check backup age

Source: https://spatie.be/docs/laravel-health/v1/available-checks/backups

Verify the age of the youngest or oldest backup files relative to the current time.

```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)),
]);
```

```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)),
]);
```

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

### Registering the Used Disk Space Check

Source: https://spatie.be/docs/laravel-health/v1/available-checks/used-disk-space

Register the check within the Health::checks array in your service provider.

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

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

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

### Check number of backups

Source: https://spatie.be/docs/laravel-health/v1/available-checks/backups

Validate the quantity of backup files within a specified range.

```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),
]);
```

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

### Conditionally run checks using if and unless

Source: https://spatie.be/docs/laravel-health/v1/basic-usage/conditionally-running-or-modifying-checks

Use if and unless methods to control check execution. These can accept boolean values or callables evaluated at runtime.

```php
use Spatie\Health\Facades\Health;
use Spatie\Health\Checks\Checks\DebugModeCheck;
use Spatie\Health\Checks\Checks\RedisCheck;

Health::checks([
    DebugModeCheck::new()->unless(app()->environment('local')),
    RedisCheck::new()->if(fn () => app(SomeHeavyService::class)->shouldCheckHealth()),
]);
```

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

### Configure JSON File Result Store

Source: https://spatie.be/docs/laravel-health/v1/storing-results/in-a-json-file

Configure the `JsonFileHealthResultStore` in your `health` config file to write check results to a JSON file. Specify the disk and filename for storage. This allows external monitoring of your application's health.

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

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

### Configure Ping URL via .env

Source: https://spatie.be/docs/laravel-health/v1/available-checks/schedule

Set the SCHEDULE_HEARTBEAT_URL in your .env file to automatically ping a URL when the scheduler is running successfully. This is useful for external monitoring services.

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

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

### Customize Cache Store for ScheduleCheck

Source: https://spatie.be/docs/laravel-health/v1/available-checks/schedule

Configure the ScheduleCheck to use a specific cache store by passing its name to the useCacheStore method. This is recommended for better isolation.

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

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

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

### Configuring a Custom Redis Connection

Source: https://spatie.be/docs/laravel-health/v1/available-checks/redis-memory-usage

Specify a custom Redis connection name for the check using the connectionName method.

```php
RedisMemoryUsageCheck::new()->connectionName('other-redis-connection-name'),
```

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

### Register OptimizedAppCheck

Source: https://spatie.be/docs/laravel-health/v1/available-checks/cached-config-routes-and-events

Register the OptimizedAppCheck to ensure config, routes, and events are cached. This check passes if all are cached.

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

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

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

### Run Health Checks Command

Source: https://spatie.be/docs/laravel-health/v1/basic-usage/manually-running-checks

Execute the main health check Artisan command. By default, it stores results and sends notifications on failure.

```bash
php artisan health:check
```

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

### Customizing the Redis connection

Source: https://spatie.be/docs/laravel-health/v1/available-checks/redis

Use the connectionName method to specify a non-default Redis connection for monitoring.

```php
RedisCheck::new()->connectionName('other-redis-connection-name'),
```

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

### Advanced Ping Configuration

Source: https://spatie.be/docs/laravel-health/v1/available-checks/schedule

Configure ping timeout in seconds and retry attempts for the ScheduleCheck. These settings provide more granular control over the ping mechanism.

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

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

### Register CPU Load Check with Custom Thresholds

Source: https://spatie.be/docs/laravel-health/v1/available-checks/cpu-load

Register the CpuLoadCheck with Laravel Health, setting custom thresholds for the 5-minute and 15-minute CPU load averages. The check will fail if the load exceeds these values.

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

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

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

### Register custom condition macros

Source: https://spatie.be/docs/laravel-health/v1/basic-usage/conditionally-running-or-modifying-checks

Define reusable condition logic by registering a macro on the Check class.

```php
use Spatie\Health\Facades\Health;
use Spatie\Health\Checks\Check;
use Spatie\Health\Checks\Checks\DebugModeCheck;
use Spatie\Health\Checks\Checks\RedisCheck;

Check::macro('ifEnvironment', fn (string|array $envs) => $this->if(fn () => app()->environment($envs)));

Health::checks([
    DebugModeCheck::new()->ifEnvironment('production')
]);
```

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

### Registering a disk space health check

Source: https://spatie.be/docs/laravel-health/v1

Register the UsedDiskSpaceCheck in a service provider to monitor disk usage with configurable warning and failure thresholds.

```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),
]);
```

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

### Schedule Model Pruning for Health Check Results

Source: https://spatie.be/docs/laravel-health/v1/storing-results/in-the-database

Schedule the 'model:prune' command in routes/console.php to manage the history table size. Explicitly add the HealthCheckResultHistoryItem model if it's not in the default 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://spatie.be/docs/laravel-health/v1/storing-results/in-cache

Defines the result store and cache driver within the health configuration file.

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

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

### Configure Eloquent Health Result Store

Source: https://spatie.be/docs/laravel-health/v1/storing-results/in-the-database

Configure the 'health_stores' key in the health config file to use the EloquentHealthResultStore. This stores check results in the database.

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

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

### Configure Health to Not Store Results

Source: https://spatie.be/docs/laravel-health/v1/storing-results/not-storing-results

Set the `health_stores` key in the `health` config file to `InMemoryHealthResultStore::class` to prevent results from being persisted.

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

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

### Add Authorization Header to MeilisearchCheck

Source: https://spatie.be/docs/laravel-health/v1/available-checks/meilisearch.md

Include an authorization header with a secret token for Meilisearch requests using the `token()` method. This is essential for protected Meilisearch instances.

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

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

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

### Register DatabaseTableSizeCheck

Source: https://spatie.be/docs/laravel-health/v1/available-checks/db-table-size-check

Register the check in the Health facade with specific table size limits.

```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),
]);
```

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

### Advanced Ping Configuration

Source: https://spatie.be/docs/laravel-health/v1/available-checks/horizon

Customizing timeout and retry attempts for the heartbeat ping.

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