As JSON | laravel-health | Spatie SPATIE Laravel Health ================= spatie.be/open-source [Docs](https://spatie.be/docs) [Laravel-health](https://spatie.be/docs/laravel-health/v1) Storing-results As JSON 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) As JSON ======= When using the `Spatie\Health\ResultStores\JsonFileHealthResultStore` result store the latest check results will be written to a JSON file. In the `health` config file, the store can be configured in the `health_stores` key like this: ``` return [ 'result_stores' => [ JsonFileHealthResultStore::class => [ 'disk' => 's3', 'file_name' => 'health.json', ], ], ``` The `disk` key can be set to any of the disks you configured in `config/filesystems.php`. Using an external disk, like `s3`, has the benefit that, should your application go down, you can still see the latest results via an S3 url. In case your app is fully down, external services monitoring your health file, should notice that the `finishedAt` key in the contents will not be updated anymore. You can parse this file get detailed information of how the checks have run. This can be used as the basis for a dashboard, or you could let an external service monitor the contents of this file. The JSON contains two top level properties: - `finishedAt`: the datetime when all checks have finished running - `checkResults`: the results of all checks Here's an example of how the content could look like: ``` { "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 } } ] } ```