PHPackages                             devexploris/myaku-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. [Logging & Monitoring](/categories/logging)
4. /
5. devexploris/myaku-health-check

ActiveSymfony-bundle[Logging & Monitoring](/categories/logging)

devexploris/myaku-health-check
==============================

Provide an endpoint for health check of application

1.0.0(3w ago)03↓100%MITPHPPHP ^8.2

Since May 17Pushed 3w agoCompare

[ Source](https://github.com/DevExploris/Myaku-Health-Check)[ Packagist](https://packagist.org/packages/devexploris/myaku-health-check)[ RSS](/packages/devexploris-myaku-health-check/feed)WikiDiscussions main Synced 1w ago

READMEChangelog (1)Dependencies (4)Versions (2)Used By (0)

Myaku Health Check
==================

[](#myaku-health-check)

A Symfony bundle exposing a `GET /health` endpoint with access control and monitoring of disk space, RAM, database and cache.

**[Official (EN) documentation →](https://devexploris.com/myaku?lang=en)****[Documentation officielle →](https://devexploris.com/myaku)**

Requirements
------------

[](#requirements)

- PHP 8.2+
- Symfony 7.4+ or 8.0+

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

[](#installation)

### 1. Require the bundle

[](#1-require-the-bundle)

```
composer require devexploris/myaku-health-check
```

### 2. Register the bundle

[](#2-register-the-bundle)

```
// config/bundles.php
return [
    Devexploris\MyakuHealthCheck\MyakuHealthCheckBundle::class => ['all' => true],
];
```

### 3. Register the route

[](#3-register-the-route)

```
# config/routes.yaml
myaku_health_check:
    resource: Devexploris\MyakuHealthCheck\Controller\HealthCheckController
    type: attribute
```

Configuration
-------------

[](#configuration)

Create `config/packages/myaku_health_check.yaml`:

```
myaku_health_check:
    threshold:                              # optional
        space: 80                           # alert if disk usage exceeds X% (0–100)
        memory: 90                          # alert if RAM usage exceeds X% (0–100)
    space:
        path: /                             # mount point to monitor (default: /)
    security:
        token: "%env(APP_MYAKU_TOKEN)%"     # generate with: openssl rand -hex 24
        whitelist:                          # optional — if empty, all IPs are allowed
            - "127.0.0.1"
            - "172.21.0.1"
```

Database and cache are auto-detected via `doctrine.dbal.default_connection` and `cache.app` — no configuration needed.

Endpoint
--------

[](#endpoint)

```
GET /health

```

### Response codes

[](#response-codes)

CodeMeaning`200`All checks are healthy`403`IP not allowed or invalid token`503`At least one check failed or exceeded its threshold### Security

[](#security)

Two controls are applied in order:

1. **IP whitelist** — if the list is not empty, the client IP must be present, otherwise `403`
2. **Token** — the `x-myaku-token` header must match the configured token, otherwise `403`

### Response

[](#response)

```
{
    "space": {
        "free": "45.30 Go",
        "used": "54.70 Go",
        "total": "100.00 Go",
        "threshold": "80%",
        "threshold_targeted": false
    },
    "memory": {
        "free": "4.77 Go",
        "used": "10.04 Go",
        "total": "14.81 Go",
        "threshold": "90%",
        "threshold_targeted": false
    },
    "database": {
        "connected": true,
        "latency": "1.23ms"
    },
    "cache": {
        "connected": true,
        "latency": "0.45ms"
    }
}
```

`threshold_targeted: true` means the usage percentage exceeds the configured threshold — triggers a `503`.

> The `threshold` and `threshold_targeted` fields only appear if the corresponding threshold is configured.

#### Database error

[](#database-error)

```
{
    "database": {
        "connected": false,
        "error": "SQLSTATE[HY000] [2002] Connection refused"
    }
}
```

#### Cache error

[](#cache-error)

```
{
    "cache": {
        "connected": false,
        "error": "No cache configured"
    }
}
```

Auto-detection
--------------

[](#auto-detection)

The bundle wires `doctrine.dbal.default_connection` and `cache.app` automatically when they are available in the container. No configuration needed — checks are simply skipped (returning `connected: false`) when the services are absent.

Compatibility
-------------

[](#compatibility)

CheckLinuxmacOSWindowsDisk space✅✅✅RAM✅❌❌Database✅✅✅Cache✅✅✅> `MemoryChecker` reads `/proc/meminfo` — available on Linux only.

License
-------

[](#license)

MIT

###  Health Score

40

—

FairBetter than 86% of packages

Maintenance95

Actively maintained with recent releases

Popularity4

Limited adoption so far

Community6

Small or concentrated contributor base

Maturity46

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 100% 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

Unknown

Total

1

Last Release

23d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/04a3720d69f934d56e9015330abe9eba083ca08fb08de543b2d803a24247cf69?d=identicon)[devexploris](/maintainers/devexploris)

---

Top Contributors

[![DevExploris](https://avatars.githubusercontent.com/u/112415977?v=4)](https://github.com/DevExploris "DevExploris (1 commits)")

---

Tags

symfonybundlemonitoringendpointhealthcheckhealth check

### Embed Badge

![Health badge](/badges/devexploris-myaku-health-check/health.svg)

```
[![Health](https://phpackages.com/badges/devexploris-myaku-health-check/health.svg)](https://phpackages.com/packages/devexploris-myaku-health-check)
```

###  Alternatives

[symfony/framework-bundle

Provides a tight integration between Symfony components and the Symfony full-stack framework

3.6k246.0M11.0k](/packages/symfony-framework-bundle)[easycorp/easyadmin-bundle

Admin generator for Symfony applications

4.3k17.5M370](/packages/easycorp-easyadmin-bundle)[sulu/sulu

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

1.3k1.4M195](/packages/sulu-sulu)

PHPackages © 2026

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