PHPackages                             oat-sa/bundle-health-check - 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. oat-sa/bundle-health-check

ActiveSymfony-bundle[Utility & Helpers](/categories/utility)

oat-sa/bundle-health-check
==========================

Health Check Bundle

2.3.2(10mo ago)436.8k↓35.4%1[1 issues](https://github.com/oat-sa/bundle-health-check/issues)LGPL-2.1-onlyPHPPHP >=7.2.0CI passing

Since Jan 29Pushed 10mo ago38 watchersCompare

[ Source](https://github.com/oat-sa/bundle-health-check)[ Packagist](https://packagist.org/packages/oat-sa/bundle-health-check)[ RSS](/packages/oat-sa-bundle-health-check/feed)WikiDiscussions master Synced 1mo ago

READMEChangelog (9)Dependencies (8)Versions (14)Used By (0)

Health Check Bundle
===================

[](#health-check-bundle)

[![Latest Version](https://camo.githubusercontent.com/dc971f28a9874145fd30d958fcfa7b7ab2f39c4c37c3fab0cab0c9b95dcf18c9/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f7461672f6f61742d73612f62756e646c652d6865616c74682d636865636b2e7376673f7374796c653d666c6174266c6162656c3d72656c65617365)](https://github.com/oat-sa/bundle-health-check/tags)[![License GPL2](https://camo.githubusercontent.com/11621b2753cca0c8efe58582e2b7f1d87b5f6c231d797c5b2459cc52cf250a06/687474703a2f2f696d672e736869656c64732e696f2f62616467652f6c6963656e63652d4c47504c253230322e312d626c75652e737667)](http://www.gnu.org/licenses/lgpl-2.1.html)[![Build Status](https://camo.githubusercontent.com/a205af9f93b17b0b1a2f5e675d50723e10765c99345861ea0835ea4ff8cad336/68747470733a2f2f7472617669732d63692e6f72672f6f61742d73612f62756e646c652d6865616c74682d636865636b2e7376673f6272616e63683d6d6173746572)](https://travis-ci.org/oat-sa/bundle-health-check)[![Coverage Status](https://camo.githubusercontent.com/56b40370641420df3da32a34501e405a5b3565c7a22e93b1a45da67f327b54a1/68747470733a2f2f636f766572616c6c732e696f2f7265706f732f6769746875622f6f61742d73612f62756e646c652d6865616c74682d636865636b2f62616467652e7376673f6272616e63683d6d6173746572)](https://coveralls.io/github/oat-sa/bbundle-health-check?branch=master)[![Packagist Downloads](https://camo.githubusercontent.com/31f2500614ec7567caf91b4e210120d5070dbe8729d51d9eb202012c1153da1b/687474703a2f2f696d672e736869656c64732e696f2f7061636b61676973742f64742f6f61742d73612f62756e646c652d6865616c74682d636865636b2e737667)](https://packagist.org/packages/oat-sa/bundle-health-check)

> [Symfony](https://symfony.com/) bundle for health checks automation, based on [health check library](https://github.com/oat-sa/lib-health-check)

Table of Contents
-----------------

[](#table-of-contents)

- [Installation](#installation)
- [Usage](#usage)
- [Tests](#tests)

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

[](#installation)

```
$ composer require oat-sa/bundle-health-check
```

**Note**: the related [flex recipe](https://github.com/symfony/recipes-contrib/tree/master/oat-sa/bundle-health-check/) will enable and auto configure the bundle in your application.

Usage
-----

[](#usage)

### Available endpoints

[](#available-endpoints)

This bundle provides by default the following endpoints:

MethodRouteDescription`GET``/ping`ensures your application is up and running (no logic)`GET``/health-check`runs registered checkers (custom logic)**Notes**:

- you can check the related [openapi documentation](openapi/health-check.yaml) for more details
- you can update / disable those routes in the `config/routes/health_check.yaml` file of your application (created by [flex recipe](https://github.com/symfony/recipes-contrib/tree/master/oat-sa/bundle-health-check/))

#### Ping

[](#ping)

The ping endpoint just returns a `200` response with the string `pong` as body.

It is just here to ensure your application is correctly installed, up and running.

#### Health Checker

[](#health-checker)

This bundle will automatically add the tag `health_check.checker` to your application services if they implement the [CheckerInterface](https://github.com/oat-sa/lib-health-check/blob/master/src/Checker/CheckerInterface.php)(they will be auto registered onto the [HealthChecker](https://github.com/oat-sa/lib-health-check/blob/master/src/HealthChecker.php) service).

If you want to register a [CheckerInterface](https://github.com/oat-sa/lib-health-check/blob/master/src/Checker/CheckerInterface.php) implementation from 3rd party libraries, you can configure them as following:

```
# config/services.yaml

services:
    My\Bundle\Checker\SomeChecker:
        tags:
            - { name: 'health_check.checker', priority: 2 }

    My\Bundle\Checker\OtherChecker:
        tags:
            - { name: 'health_check.checker', priority: 1 }
```

**Note**: you can use the `priority` property of the `health_check.checker` tag to order them.

### Available command

[](#available-command)

If you prefer to run your checks in CLI mode, this bundle provides by default the following command:

```
$ bin/console health:check
```

**Notes**:

- it runs registered checkers as explained in section above
- it returns `0` in case of overall success, or `1` if one (or more than one) checker failed
- it displays a summary of all executed checkers and their result

Tests
-----

[](#tests)

To run provided tests:

```
$ vendor/bin/phpunit
```

**Note**: see [phpunit file](phpunit.xml.dist) for available suites.

###  Health Score

43

—

FairBetter than 91% of packages

Maintenance48

Moderate activity, may be stable

Popularity33

Limited adoption so far

Community22

Small or concentrated contributor base

Maturity59

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 68.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 ~246 days

Recently: every ~388 days

Total

9

Last Release

329d ago

Major Versions

0.1.0 → 1.0.02020-06-25

1.1.0 → 2.0.02021-03-23

PHP version history (2 changes)0.1.0PHP ^7.2.5

2.0.0PHP >=7.2.0

### Community

Maintainers

![](https://www.gravatar.com/avatar/c0ec704e0a8abaf0c27b227ad05d7aca23bc8f83d195229d94d4508cddc0fd24?d=identicon)[oat-lionel](/maintainers/oat-lionel)

![](https://www.gravatar.com/avatar/e8c30644c0da147701176483ca1ca40e1c41012e6c5b0da47e984c1eb8a840b1?d=identicon)[jbout](/maintainers/jbout)

![](https://www.gravatar.com/avatar/f731fe2eae4a6ce6ec9b5861d09767abe548d259fa293ca5bd3a9cca446227ba?d=identicon)[ekkinox](/maintainers/ekkinox)

---

Top Contributors

[![ekkinox](https://avatars.githubusercontent.com/u/6922385?v=4)](https://github.com/ekkinox "ekkinox (28 commits)")[![kilatib](https://avatars.githubusercontent.com/u/2750628?v=4)](https://github.com/kilatib "kilatib (4 commits)")[![yaraslau-kavaliou](https://avatars.githubusercontent.com/u/72205523?v=4)](https://github.com/yaraslau-kavaliou "yaraslau-kavaliou (3 commits)")[![edwin-focaloid](https://avatars.githubusercontent.com/u/126317720?v=4)](https://github.com/edwin-focaloid "edwin-focaloid (2 commits)")[![peetya](https://avatars.githubusercontent.com/u/18699247?v=4)](https://github.com/peetya "peetya (2 commits)")[![Babacooll](https://avatars.githubusercontent.com/u/6329406?v=4)](https://github.com/Babacooll "Babacooll (1 commits)")[![mike-ionut-mihai-sandu-tao](https://avatars.githubusercontent.com/u/50211080?v=4)](https://github.com/mike-ionut-mihai-sandu-tao "mike-ionut-mihai-sandu-tao (1 commits)")

---

Tags

health-checkhealthchecksymfonysymfony-bundlesymfonycheckhealth

###  Code Quality

TestsPHPUnit

### Embed Badge

![Health badge](/badges/oat-sa-bundle-health-check/health.svg)

```
[![Health](https://phpackages.com/badges/oat-sa-bundle-health-check/health.svg)](https://phpackages.com/packages/oat-sa-bundle-health-check)
```

###  Alternatives

[sulu/sulu

Core framework that implements the functionality of the Sulu content management system

1.3k1.3M152](/packages/sulu-sulu)[cognesy/instructor-php

The complete AI toolkit for PHP: unified LLM API, structured outputs, agents, and coding agent control

310107.9k1](/packages/cognesy-instructor-php)[netgen/layouts-core

Netgen Layouts enables you to build and manage complex web pages in a simpler way and with less coding. This is the core of Netgen Layouts, its heart and soul.

3689.4k10](/packages/netgen-layouts-core)[aedart/athenaeum

Athenaeum is a mono repository; a collection of various PHP packages

245.2k](/packages/aedart-athenaeum)

PHPackages © 2026

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