PHPackages                             fr3on/magento2-healthz - 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. fr3on/magento2-healthz

ActiveMagento2-module[Logging & Monitoring](/categories/logging)

fr3on/magento2-healthz
======================

Health check endpoints for Magento 2 — liveness, readiness, and detail probes

0.0.1(3mo ago)08MITPHPPHP >=8.1CI passing

Since Apr 15Pushed 3mo agoCompare

[ Source](https://github.com/fr3on/magento2-healthz)[ Packagist](https://packagist.org/packages/fr3on/magento2-healthz)[ RSS](/packages/fr3on-magento2-healthz/feed)WikiDiscussions main Synced 1w ago

READMEChangelogDependencies (5)Versions (2)Used By (0)

Magento 2 Healthz
=================

[](#magento-2-healthz)

[![CI](https://github.com/fr3on/magento2-healthz/actions/workflows/ci.yml/badge.svg)](https://github.com/fr3on/magento2-healthz/actions/workflows/ci.yml)[![Latest Stable Version](https://camo.githubusercontent.com/f6aed95a543ae8ae141b27b9e5e4b9d387713f144f53f925ac6f4ab8011bfaff/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f6672336f6e2f6d6167656e746f322d6865616c74687a)](https://packagist.org/packages/fr3on/magento2-healthz)[![License](https://camo.githubusercontent.com/f40042d820ae30ecd0a9391ae5032e73588d067e10f651092c55a269dbd55ff9/68747470733a2f2f696d672e736869656c64732e696f2f6769746875622f6c6963656e73652f6672336f6e2f6d6167656e746f322d6865616c74687a)](LICENSE)[![PHP Version Support](https://camo.githubusercontent.com/e856361f96c08e68c7cdb237c18fc2040203511f3ced45ffe20bc3b0fe4e943c/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f7068702d762f6672336f6e2f6d6167656e746f322d6865616c74687a)](https://packagist.org/packages/fr3on/magento2-healthz)[![Total Downloads](https://camo.githubusercontent.com/b93c347649940bc2d614167ae01f36237e97ac8670586bed612b39e9cb75e0c5/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f64742f6672336f6e2f6d6167656e746f322d6865616c74687a)](https://packagist.org/packages/fr3on/magento2-healthz)

Professional health check endpoints for Magento 2. Designed for Kubernetes liveness/readiness probes, Docker healthchecks, and load balancer monitoring.

Features
--------

[](#features)

- **Three Endpoints**: `/live`, `/ready`, and `/detail`.
- **Zero Configuration**: Works out of the box.
- **Fail-Safe**: Every check is wrapped in try/catch and has hard timeouts.
- **Fast**: Bypasses Magento layout rendering and Full Page Cache.
- **Extensible**: Add custom checks via `di.xml`.

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

[](#installation)

```
composer require fr3on/magento2-healthz
bin/magento module:enable Fr3on_Healthz
bin/magento setup:upgrade
```

Endpoints
---------

[](#endpoints)

### 1. Liveness Probe: `GET /_health/live`

[](#1-liveness-probe-get-_healthlive)

Answers: "Is the PHP process alive and Magento bootstrapped?"

- **Success**: `200 OK`
- **Use for**: Kubernetes `livenessProbe`.

### 2. Readiness Probe: `GET /_health/ready`

[](#2-readiness-probe-get-_healthready)

Answers: "Can this instance serve traffic right now?"

- **Checks**: Database connectivity, Cache backend, Maintenance mode.
- **Success**: `200 OK`
- **Failure**: `503 Service Unavailable`
- **Use for**: Kubernetes `readinessProbe`, Load Balancer health checks.

### 3. Detail Probe: `GET /_health/detail`

[](#3-detail-probe-get-_healthdetail)

Answers: "What is the status of all subsystems?"

- **Checks**: All readiness checks + Disk space, Queue, Elasticsearch, Sessions.
- **Protection**: Can be protected by a token in Admin Config.
- **Use for**: Ops dashboards, post-deployment verification.

Kubernetes Configuration
------------------------

[](#kubernetes-configuration)

```
livenessProbe:
  httpGet:
    path: /_health/live
    port: 80
  initialDelaySeconds: 30
  periodSeconds: 10

readinessProbe:
  httpGet:
    path: /_health/ready
    port: 80
  initialDelaySeconds: 10
  periodSeconds: 5
  failureThreshold: 3
```

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

[](#configuration)

Settings are available in **Stores > Configuration > Fr3on > Healthz**:

- **Enabled**: Enable/Disable endpoints.
- **Detail Token**: Secret token for the `/detail` endpoint.
- **Disk Threshold (GB)**: Warning threshold for free space in `var/`.
- **Check Timeout (ms)**: Max duration for any single check.

License
-------

[](#license)

MIT

###  Health Score

32

—

LowBetter than 69% of packages

Maintenance81

Actively maintained with recent releases

Popularity4

Limited adoption so far

Community6

Small or concentrated contributor base

Maturity32

Early-stage or recently created project

 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

100d ago

### Community

Maintainers

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

---

Top Contributors

[![fr3on](https://avatars.githubusercontent.com/u/26393383?v=4)](https://github.com/fr3on "fr3on (13 commits)")

---

Tags

devopsdockerhealthhealthcheckkuberneteslivenessmagento2monitoringphpprobereadinessmonitoringhealthmagentodevopsdockermagento2healthcheckkubernetesprobereadinessliveness

###  Code Quality

TestsPHPUnit

### Embed Badge

![Health badge](/badges/fr3on-magento2-healthz/health.svg)

```
[![Health](https://phpackages.com/badges/fr3on-magento2-healthz/health.svg)](https://phpackages.com/packages/fr3on-magento2-healthz)
```

###  Alternatives

[smile/elasticsuite

Magento 2 merchandising and search engine built on ElasticSearch

8064.7M50](/packages/smile-elasticsuite)[mollie/magento2

Mollie Payment Module for Magento 2

1131.9M16](/packages/mollie-magento2)[run-as-root/magento2-prometheus-exporter

Magento2 Prometheus Exporter

68357.9k](/packages/run-as-root-magento2-prometheus-exporter)[opengento/module-category-import-export

This module add the capability to import and export the categories from the back-office.

1310.9k2](/packages/opengento-module-category-import-export)[loki/magento2-components

Core module for defining Alpine.js components with advanced AJAX features

1011.8k26](/packages/loki-magento2-components)[mage-os/module-admin-activity-log

The Admin Activity extension makes it easy to track all admin activity with comprehensive audit logging.

296.3k1](/packages/mage-os-module-admin-activity-log)

PHPackages © 2026

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