PHPackages                             spatie/statamic-health - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Utility &amp; Helpers](/categories/utility)
4. /
5. spatie/statamic-health

ActiveLibrary[Utility &amp; Helpers](/categories/utility)

spatie/statamic-health
======================

Check the health of your Statamic app

1.0.0(4y ago)115.3k1MITBladePHP ^8.0CI passing

Since Feb 2Pushed 1mo ago1 watchersCompare

[ Source](https://github.com/spatie/statamic-health)[ Packagist](https://packagist.org/packages/spatie/statamic-health)[ Docs](https://github.com/spatie/statamic-health)[ GitHub Sponsors](https://github.com/spatie)[ RSS](/packages/spatie-statamic-health/feed)WikiDiscussions main Synced 3d ago

READMEChangelog (1)Dependencies (12)Versions (3)Used By (0)

Check the health of your Statamic app
=====================================

[](#check-the-health-of-your-statamic-app)

[![Latest Version on Packagist](https://camo.githubusercontent.com/072811730bbbac25eada36ebebca5977bad766a01337806e84042e68907a0a77/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f7370617469652f73746174616d69632d6865616c74682e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/spatie/statamic-health)[![GitHub Tests Action Status](https://camo.githubusercontent.com/8310be12f6f029ebfe538a0cde75bb1dc31d357063dfd31212def299ddfc52b3/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f776f726b666c6f772f7374617475732f7370617469652f73746174616d69632d6865616c74682f72756e2d74657374733f6c6162656c3d7465737473)](https://github.com/spatie/statamic-health/actions?query=workflow%3Arun-tests+branch%3Amain)[![GitHub Code Style Action Status](https://camo.githubusercontent.com/cd9e2ae284d19b07e02ae642faab615c267fa366b4ef3cd7b86e9da0836272b7/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f776f726b666c6f772f7374617475732f7370617469652f73746174616d69632d6865616c74682f436865636b253230262532306669782532307374796c696e673f6c6162656c3d636f64652532307374796c65)](https://github.com/spatie/statamic-health/actions?query=workflow%3A%22Check+%26+fix+styling%22+branch%3Amain)[![Total Downloads](https://camo.githubusercontent.com/fbf0d20f80707d9c624ce240cb15f8bb99b1f4ae66f946ac65748577986e1a4b/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f64742f7370617469652f73746174616d69632d6865616c74682e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/spatie/statamic-health)

[![Screenshot](https://github.com/spatie/statamic-health/raw/main/docs/screenshot.png)](https://github.com/spatie/statamic-health/raw/main/docs/screenshot.png)

Using this addon you can monitor the health of your application by registering checks.

Here's an example where we'll monitor available 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.

Support us
----------

[](#support-us)

[![](https://camo.githubusercontent.com/31f37686a8cdc71585005f83c8e0f38e9a838cd6cc5bd9088d9ab0938dcc314e/68747470733a2f2f6769746875622d6164732e73332e65752d63656e7472616c2d312e616d617a6f6e6177732e636f6d2f73746174616d69632d6865616c74682e6a70673f743d31)](https://spatie.be/github-ad-click/statamic-health)

We invest a lot of resources into creating [best in class open source packages](https://spatie.be/open-source). You can support us by [buying one of our paid products](https://spatie.be/open-source/support-us).

We highly appreciate you sending us a postcard from your hometown, mentioning which of our package(s) you are using. You'll find our address on [our contact page](https://spatie.be/about-us). We publish all received postcards on [our virtual postcard wall](https://spatie.be/open-source/postcards).

Installation
------------

[](#installation)

Publish the `laravel-health` config file

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

Remove the `EloquentHealthResultStore` in the `health_stores` array and replace it by the following:

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

This will store the result of the health checks in a json file instead of trying to access a database.

Documentation
-------------

[](#documentation)

This addon uses the [Laravel Health](https://spatie.be/docs/laravel-health) package, for more information on the package itself check out the docs.

### Widget

[](#widget)

This addon provides you with the possibility of adding health check widgets to your Statamic dashboard, you can add any Health check by configuring the widget in `config/statamic/cp.php` like this:

```
'widgets' => [
    [
        'type' => 'health_check',
        'check' => \Spatie\Health\Checks\Checks\UsedDiskSpaceCheck::class,
        'width' => 33,
    ],
    ...
],
```

Make sure you've configured the Health check correctly before adding it to your dashboard.

### Disabling the Health control panel section

[](#disabling-the-health-control-panel-section)

If you want to disable the Health section in the control panel, for example when you've added all the widgets to the Statamic dashboard instead, you can add the following config key to the Laravel health (`config/health.php`) file:

```
'statamic' => [
    'enable_dashboard' => false,
]
```

Testing
-------

[](#testing)

```
composer test
```

Changelog
---------

[](#changelog)

Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.

Contributing
------------

[](#contributing)

Please see [CONTRIBUTING](https://github.com/spatie/.github/blob/main/CONTRIBUTING.md) for details.

Security Vulnerabilities
------------------------

[](#security-vulnerabilities)

Please review [our security policy](../../security/policy) on how to report security vulnerabilities.

Credits
-------

[](#credits)

- [Rias Van der Veken](https://github.com/riasvdv)
- [All Contributors](../../contributors)

License
-------

[](#license)

The MIT License (MIT). Please see [License File](LICENSE.md) for more information.

###  Health Score

42

—

FairBetter than 88% of packages

Maintenance61

Regular maintenance activity

Popularity25

Limited adoption so far

Community15

Small or concentrated contributor base

Maturity56

Maturing project, gaining track record

 Bus Factor2

2 contributors hold 50%+ of commits

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Unknown

Total

1

Last Release

1614d ago

### Community

Maintainers

![](https://avatars.githubusercontent.com/u/7535935?v=4)[Spatie](/maintainers/spatie)[@spatie](https://github.com/spatie)

---

Top Contributors

[![dependabot[bot]](https://avatars.githubusercontent.com/in/29110?v=4)](https://github.com/dependabot[bot] "dependabot[bot] (21 commits)")[![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?v=4)](https://github.com/github-actions[bot] "github-actions[bot] (16 commits)")[![riasvdv](https://avatars.githubusercontent.com/u/3626559?v=4)](https://github.com/riasvdv "riasvdv (7 commits)")[![AdrianMrn](https://avatars.githubusercontent.com/u/12762044?v=4)](https://github.com/AdrianMrn "AdrianMrn (4 commits)")[![freekmurze](https://avatars.githubusercontent.com/u/483853?v=4)](https://github.com/freekmurze "freekmurze (2 commits)")[![AlexVanderbist](https://avatars.githubusercontent.com/u/6287961?v=4)](https://github.com/AlexVanderbist "AlexVanderbist (2 commits)")[![Nielsvanpach](https://avatars.githubusercontent.com/u/10651054?v=4)](https://github.com/Nielsvanpach "Nielsvanpach (2 commits)")

---

Tags

spatielaravelstatamic-health

###  Code Quality

TestsPest

### Embed Badge

![Health badge](/badges/spatie-statamic-health/health.svg)

```
[![Health](https://phpackages.com/badges/spatie-statamic-health/health.svg)](https://phpackages.com/packages/spatie-statamic-health)
```

###  Alternatives

[spatie/laravel-data

Create unified resources and data transfer objects

1.8k35.2M976](/packages/spatie-laravel-data)[spatie/laravel-livewire-wizard

Build wizards using Livewire

4181.2M6](/packages/spatie-laravel-livewire-wizard)[statamic/seo-pro

68516.6k](/packages/statamic-seo-pro)[spatie/laravel-screenshot

Take screenshots of web pages in Laravel apps

8195.1k5](/packages/spatie-laravel-screenshot)[marcorieser/statamic-livewire

A Laravel Livewire integration for Statamic.

23111.5k15](/packages/marcorieser-statamic-livewire)[victord11/ssl-certification-health-check

A Laravel Health check to SSL certification

17157.8k](/packages/victord11-ssl-certification-health-check)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)
