PHPackages                             chocofamilyme/laravel-healthcheck - 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 & Helpers](/categories/utility)
4. /
5. chocofamilyme/laravel-healthcheck

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

chocofamilyme/laravel-healthcheck
=================================

Serves functionality of healthchecks of your application

4.0.0(3y ago)11134.3k↑170.7%1BSD-3-ClausePHPPHP ^8.0.2

Since Aug 8Pushed 3y ago4 watchersCompare

[ Source](https://github.com/chocofamilyme/laravel-healthcheck)[ Packagist](https://packagist.org/packages/chocofamilyme/laravel-healthcheck)[ RSS](/packages/chocofamilyme-laravel-healthcheck/feed)WikiDiscussions master Synced 3d ago

READMEChangelog (10)Dependencies (8)Versions (17)Used By (0)

Laravel Health Check Library
============================

[](#laravel-health-check-library)

Health Check library adds new endpoints(routes) to your project which are used to check some services of your application. For example you want to check "Database Connection" of your microservice.

Installation
============

[](#installation)

```
composer require chocofamilyme/laravel-healthcheck ^2.0
```

Publishing the configuration (optional)
=======================================

[](#publishing-the-configuration-optional)

```
php artisan vendor:publish --provider="Chocofamilyme\LaravelHealthCheck\Providers\HealthCheckServiceProvider"
```

Checks
======

[](#checks)

- Database connection check
- Cache write&read check
- Sessions write&read check
- Storage check

Routes
======

[](#routes)

- /health

```
{
  "DB": "OK",
  "CACHE": "OK",
  "SESSIONS": "CRITICAL",
  "STORAGE": "OK"
}
```

- /health/extended

```
{
  "DB": {
    "STATUS": "OK",
    "STATUS_BOOL": true,
    "MESSAGE": null
  },
  "CACHE": {
    "STATUS": "OK",
    "STATUS_BOOL": true,
    "MESSAGE": null
  },
  "SESSIONS": {
    "STATUS": "CRITICAL",
    "STATUS_BOOL": false,
    "MESSAGE": "Connection to tarantool.example.com failed"
  },
  "STORAGE": {
    "STATUS": "OK",
    "STATUS_BOOL": true,
    "MESSAGE": null
  }
}
```

How to write your custom checks
===============================

[](#how-to-write-your-custom-checks)

Create a class which implements Chocofamilyme\\LaravelHealthCheck\\Services\\Checks\\ComponentCheckInterface and add it to healthcheck.php config file like

```
return [
    'componentChecks' => [
        'YOURCUSTOMCHECK' => YourCustomCheck::class
    ]
]
```

Responses
=========

[](#responses)

There is a configuration param which describes which response class to use to output the response. For example

- /health - Chocofamilyme\\LaravelHealthCheck\\Responses\\Response::class output would look like this

```
{
  "DB": "OK",
  "CACHE": "OK",
  "SESSIONS": "CRITICAL",
  "STORAGE": "OK"
}
```

- /health - Chocofamilyme\\LaravelHealthCheck\\Responses\\Response::class output would look like this

```
{
    "data": {
        "DB": "OK",
        "CACHE": "OK",
        "SESSIONS": "CRITICAL",
        "STORAGE": "OK"
    }
}
```

Feel free to add your responses, if you want for example to output it in a view instead json.

###  Health Score

41

—

FairBetter than 87% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity40

Moderate usage in the ecosystem

Community15

Small or concentrated contributor base

Maturity72

Established project with proven stability

 Bus Factor1

Top contributor holds 58.3% of commits — single point of failure

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

Every ~109 days

Recently: every ~271 days

Total

13

Last Release

1216d ago

Major Versions

0.0.6 → 1.0.02020-03-13

1.0.2 → 2.0.02020-10-30

2.0.1 → 3.0.02022-04-12

3.0.0 → 4.0.02023-03-07

PHP version history (4 changes)0.0.1PHP >= 7.0.0

1.0.0PHP >= 7.1.0

2.0.0PHP >= 7.4

3.0.0PHP ^8.0.2

### Community

Maintainers

![](https://avatars.githubusercontent.com/u/42729426?v=4)[Chocofamily](/maintainers/chocofamilyme)[@chocofamilyme](https://github.com/chocofamilyme)

---

Top Contributors

[![igor875126](https://avatars.githubusercontent.com/u/11134711?v=4)](https://github.com/igor875126 "igor875126 (7 commits)")[![Vadim89](https://avatars.githubusercontent.com/u/3715929?v=4)](https://github.com/Vadim89 "Vadim89 (2 commits)")[![0x3337](https://avatars.githubusercontent.com/u/6462138?v=4)](https://github.com/0x3337 "0x3337 (1 commits)")[![AidynMakhataev](https://avatars.githubusercontent.com/u/19181566?v=4)](https://github.com/AidynMakhataev "AidynMakhataev (1 commits)")[![dias-zhanabayev](https://avatars.githubusercontent.com/u/46632797?v=4)](https://github.com/dias-zhanabayev "dias-zhanabayev (1 commits)")

---

Tags

laravelstatushealthcheck

###  Code Quality

Static AnalysisPsalm

Code StylePHP\_CodeSniffer

Type Coverage Yes

### Embed Badge

![Health badge](/badges/chocofamilyme-laravel-healthcheck/health.svg)

```
[![Health](https://phpackages.com/badges/chocofamilyme-laravel-healthcheck/health.svg)](https://phpackages.com/packages/chocofamilyme-laravel-healthcheck)
```

###  Alternatives

[psalm/plugin-laravel

Psalm plugin for Laravel

3355.3M346](/packages/psalm-plugin-laravel)[laravel/pulse

Laravel Pulse is a real-time application performance monitoring tool and dashboard for your Laravel application.

1.7k15.1M132](/packages/laravel-pulse)[roots/acorn

Framework for Roots WordPress projects built with Laravel components.

9762.4M131](/packages/roots-acorn)[api-platform/laravel

API Platform support for Laravel

58171.6k14](/packages/api-platform-laravel)[mike-bronner/laravel-model-caching

Automatic caching for Eloquent models.

2.4k91.9k1](/packages/mike-bronner-laravel-model-caching)

PHPackages © 2026

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