Introduction | laravel-health | Spatie SPATIE Laravel Health ================= spatie.be/open-source [Docs](https://spatie.be/docs) [Laravel-health](https://spatie.be/docs/laravel-health/v1) Introduction 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) Laravel Health ================ Check the health of your Laravel app [ Repository ](https://github.com/spatie/laravel-health) 10,119,774 858 Introduction ------------ Using this package you can monitor the health of your application by registering one of [the available checks](/docs/laravel-health/v1/available-checks/overview). Here's an example where we'll monitor used disk space. ``` // typically, in a service provider use Spatie\Health\Facades\Health; use Spatie\Health\Checks\Checks\UsedDiskSpaceCheck; Health::checks([ UsedDiskSpaceCheck::new() ->warnWhenUsedSpaceIsAbovePercentage(70) ->failWhenUsedSpaceIsAbovePercentage(90), ]); ``` When the used disk space is over 70%, then a notification with a warning will be sent. If it's above 90%, you'll get an error notification. Out of the box, the package can notify you via mail and Slack. You'll find a [list of available checks](/docs/laravel-health/v1/available-checks/overview) here. Need a custom check? No problem, you [can create your own check](/docs/laravel-health/v1/basic-usage/creating-custom-checks) in no time. The package can also display [a beautiful overview](/docs/laravel-health/v1/viewing-results/on-a-webpage) of all health check results. ![image](/docs/laravel-health/v1/images/list-web-dark.png)