Installation & setup | laravel-health | Spatie SPATIE Laravel Health ================= spatie.be/open-source [Docs](https://spatie.be/docs) [Laravel-health](https://spatie.be/docs/laravel-health/v1) Installation & setup Version v1 Other versions for crawler [v1](https://spatie.be/docs/laravel-health/v1) - [ Introduction ](https://spatie.be/docs/laravel-health/v1/introduction) - [ Support us ](https://spatie.be/docs/laravel-health/v1/support-us) - [ Requirements ](https://spatie.be/docs/laravel-health/v1/requirements) - [ Installation & setup ](https://spatie.be/docs/laravel-health/v1/installation-setup) - [ Questions and issues ](https://spatie.be/docs/laravel-health/v1/questions-issues) - [ Changelog ](https://spatie.be/docs/laravel-health/v1/changelog) - [ About us ](https://spatie.be/docs/laravel-health/v1/about-us) Usage ----- - [ Registering your first check ](https://spatie.be/docs/laravel-health/v1/basic-usage/registering-your-first-check) - [ Creating custom checks ](https://spatie.be/docs/laravel-health/v1/basic-usage/creating-custom-checks) - [ Manually running checks ](https://spatie.be/docs/laravel-health/v1/basic-usage/manually-running-checks) - [ Conditionally running or modifying checks ](https://spatie.be/docs/laravel-health/v1/basic-usage/conditionally-running-or-modifying-checks) - [ Endpoints ](https://spatie.be/docs/laravel-health/v1/basic-usage/endpoints) - [ Pausing and resuming checks ](https://spatie.be/docs/laravel-health/v1/basic-usage/pausing-and-resuming-checks) - [ Registering the same check multiple times ](https://spatie.be/docs/laravel-health/v1/basic-usage/registering-the-same-check-multiple-times) - [ Testing ](https://spatie.be/docs/laravel-health/v1/basic-usage/testing) Storing results --------------- - [ General ](https://spatie.be/docs/laravel-health/v1/storing-results/general) - [ As JSON ](https://spatie.be/docs/laravel-health/v1/storing-results/in-a-json-file) - [ In the cache ](https://spatie.be/docs/laravel-health/v1/storing-results/in-cache) - [ In the database ](https://spatie.be/docs/laravel-health/v1/storing-results/in-the-database) - [ Not storing results ](https://spatie.be/docs/laravel-health/v1/storing-results/not-storing-results) Configuring notifications ------------------------- - [ General ](https://spatie.be/docs/laravel-health/v1/configuring-notifications/general) - [ Via mail ](https://spatie.be/docs/laravel-health/v1/configuring-notifications/via-mail) - [ Via Slack ](https://spatie.be/docs/laravel-health/v1/configuring-notifications/via-slack) - [ Via Oh Dear ](https://spatie.be/docs/laravel-health/v1/configuring-notifications/via-oh-dear) Viewing check results --------------------- - [ General ](https://spatie.be/docs/laravel-health/v1/viewing-results/general) - [ On a webpage ](https://spatie.be/docs/laravel-health/v1/viewing-results/on-a-webpage) - [ On the CLI ](https://spatie.be/docs/laravel-health/v1/viewing-results/on-the-cli) - [ As JSON ](https://spatie.be/docs/laravel-health/v1/viewing-results/as-json) Available checks ---------------- - [ Overview ](https://spatie.be/docs/laravel-health/v1/available-checks/overview) - [ Backups ](https://spatie.be/docs/laravel-health/v1/available-checks/backups) - [ Application Cache ](https://spatie.be/docs/laravel-health/v1/available-checks/cache) - [ Cached config, routes, and events ](https://spatie.be/docs/laravel-health/v1/available-checks/cached-config-routes-and-events) - [ CPU load ](https://spatie.be/docs/laravel-health/v1/available-checks/cpu-load) - [ DB connection ](https://spatie.be/docs/laravel-health/v1/available-checks/db-connection) - [ DB connection count ](https://spatie.be/docs/laravel-health/v1/available-checks/db-connection-count) - [ DB size ](https://spatie.be/docs/laravel-health/v1/available-checks/db-size-check) - [ DB table size ](https://spatie.be/docs/laravel-health/v1/available-checks/db-table-size-check) - [ Debug mode ](https://spatie.be/docs/laravel-health/v1/available-checks/debug-mode) - [ Environment ](https://spatie.be/docs/laravel-health/v1/available-checks/environment) - [ Flare error count ](https://spatie.be/docs/laravel-health/v1/available-checks/flare-error-count) - [ Horizon ](https://spatie.be/docs/laravel-health/v1/available-checks/horizon) - [ Meilisearch ](https://spatie.be/docs/laravel-health/v1/available-checks/meilisearch) - [ Ping ](https://spatie.be/docs/laravel-health/v1/available-checks/ping) - [ Queue ](https://spatie.be/docs/laravel-health/v1/available-checks/queue) - [ Redis ](https://spatie.be/docs/laravel-health/v1/available-checks/redis) - [ Redis memory usage ](https://spatie.be/docs/laravel-health/v1/available-checks/redis-memory-usage) - [ Schedule ](https://spatie.be/docs/laravel-health/v1/available-checks/schedule) - [ Security advisories ](https://spatie.be/docs/laravel-health/v1/available-checks/security-advisories) - [ Used disk space ](https://spatie.be/docs/laravel-health/v1/available-checks/used-disk-space) Security -------- - [ Using Secret Token ](https://spatie.be/docs/laravel-health/v1/security/using-secret-token) Installation & setup ======================== ### On this page 1. [ Publishing the config file ](#content-publishing-the-config-file) 2. [ Migrating the database ](#content-migrating-the-database) 3. [ Running the checks by scheduling a command ](#content-running-the-checks-by-scheduling-a-command) 4. [ Running the checks by sending HTTP requests ](#content-running-the-checks-by-sending-http-requests) You can install the package via composer: ``` composer require spatie/laravel-health ``` Publishing the config file -------------------------------------------------------------------------------------------------------------------------------------- Optionally, you can publish the `health` config file with this command. ``` php artisan vendor:publish --tag="health-config" ``` This is the content of the published config file: ``` 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, ]; ``` Migrating the database -------------------------------------------------------------------------------------------------------------------------- This package can store health check results [in various ways](https://spatie.be/docs/laravel-health/v1/storing-results/general). When using the `EloquentHealthResultStore` the check results will be stored in the database. To create the `health_check_result_history_items` table, you must create and run the migration. ``` php artisan vendor:publish --tag="health-migrations" php artisan migrate ``` These steps are not necessary when using the `JsonFileResultStore`. Running the checks by scheduling a command -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- If you want to let your application send notifications when something is wrong, you should schedule the `RunHealthChecksCommand` to run every minute. ``` // in route/console.php use Illuminate\Support\Facades\Schedule; Schedule::command(\Spatie\Health\Commands\RunHealthChecksCommand::class)->everyMinute(); ``` Running the checks by sending HTTP requests ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- If you don't want to let your application send notification, but let a service like Oh Dear monitor the health of your app, you can trigger a run of all health checks by visiting the [HTTP endpoint](https://spatie.be/docs/laravel-health/v1/viewing-results/on-a-webpage) or [JSON endpoint](https://spatie.be/docs/laravel-health/v1/viewing-results/as-json) and use the `?fresh` parameter in the URL.