Download the PHP package devexploris/myaku-health-check without Composer
On this page you can find all versions of the php package devexploris/myaku-health-check. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download devexploris/myaku-health-check
More information about devexploris/myaku-health-check
Files in devexploris/myaku-health-check
Package myaku-health-check
Short Description Provide an endpoint for health check of application
License MIT
Informations about the package 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 → Documentation officielle →
Requirements
- PHP 8.2+
- Symfony 7.4+ or 8.0+
Installation
1. Require the bundle
2. Register the bundle
3. Register the route
Configuration
Create config/packages/myaku_health_check.yaml:
Database and cache are auto-detected via doctrine.dbal.default_connection and cache.app — no configuration needed.
Endpoint
Response codes
| Code | Meaning |
|---|---|
200 |
All checks are healthy |
403 |
IP not allowed or invalid token |
503 |
At least one check failed or exceeded its threshold |
Security
Two controls are applied in order:
- IP whitelist — if the list is not empty, the client IP must be present, otherwise
403 - Token — the
x-myaku-tokenheader must match the configured token, otherwise403
Response
threshold_targeted: true means the usage percentage exceeds the configured threshold — triggers a 503.
The
thresholdandthreshold_targetedfields only appear if the corresponding threshold is configured.
Database error
Cache error
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
| Check | Linux | macOS | Windows |
|---|---|---|---|
| Disk space | ✅ | ✅ | ✅ |
| RAM | ✅ | ❌ | ❌ |
| Database | ✅ | ✅ | ✅ |
| Cache | ✅ | ✅ | ✅ |
MemoryCheckerreads/proc/meminfo— available on Linux only.
License
MIT
All versions of myaku-health-check with dependencies
symfony/http-kernel Version ^7.4|^8.0
symfony/routing Version ^7.4|^8.0
symfony/dependency-injection Version ^7.4|^8.0
php Version ^8.2