PHPackages                             ttree/health - 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. ttree/health

ActiveNeos-package[Utility & Helpers](/categories/utility)

ttree/health
============

health checker for Flow framework and Neos CMS

76[2 issues](https://github.com/ttreeagency/Health/issues)PHP

Since Mar 12Pushed 5y ago3 watchersCompare

[ Source](https://github.com/ttreeagency/Health)[ Packagist](https://packagist.org/packages/ttree/health)[ RSS](/packages/ttree-health/feed)WikiDiscussions master Synced 3d ago

READMEChangelogDependenciesVersions (1)Used By (0)

Health Monitoring for Flow Framework or Neos CMS
================================================

[](#health-monitoring-for-flow-framework-or-neos-cms)

*Package in development, not ready for production*

Features
--------

[](#features)

- Create endpoints to display your application health status
- API to create multiple health status endpoints
- API to create custom check
- Implement a health check for Database monitoring
- Implement a health check for ElasticSearch monitoring
- Implement a health check for Redis monitoring
- Create endpoints to display your application metrics (promotheus)
- API to create multiple metrics endpoints
- API to create custom metrics
- Implement a metrics for the number of node in the CR, for live workspace
- Implement a metrics for the number of node in the CR, for non live workspaces
- Implement a metrics for database size
- Implement a metrics for elasticsearch indexes size
- Implement a metrics for asset disk usage

How to create custom status endpoints ?
---------------------------------------

[](#how-to-create-custom-status-endpoints-)

In your `Settings.yaml`:

### Preset definition

[](#preset-definition)

```
Ttree:
  Health:
    presets:
      default:
        checks:
          database:
            class: Ttree\Health\Check\DatabaseCheck
          elasticsearch:
            class: Ttree\Health\Check\ElasticSearchCheck
          newsletterSender:
            class: Ttree\Health\Check\NewsletterSenderCheck

```

### Routing configuration

[](#routing-configuration)

Then you can create your routing configuration, in your `Routes.yaml`:

```
-
  name: 'health - monitoring endpoint'
  uriPattern: 'health'
  defaults:
    '@package':    'Ttree.Health'
    '@controller': 'Monitoring'
    '@action':     'index'
    '@format':     'json'
    'preset':      'default'
  appendExceedingArguments: true
  httpMethods: [GET]

```

The response should be something like this:

```
{
  "endpoint": "default",
  "success": {
    "count": 1,
    "message": {
      "database": {
        "status": "Success",
        "message": "Database access works"
      }
    }
  },
  "warnings": {
    "count": 1,
    "message": {
      "elasticsearch": {
        "status": "Warning",
        "message": "ElasticSearchCheck is not in green state"
      }
    }
  },
  "errors": {
    "count": 1,
    "message": {
      "newsletterSender": {
        "status": "Error",
        "message": "Newsletter Sender is down"
      }
    }
  }
}
```

The response status is `200` if there is not errors and warnings.

How to create custom check ?
----------------------------

[](#how-to-create-custom-check-)

Your custom check must implement `Ttree\Health\Check\CheckInterface`. The response of the `run` method must return an instance of `Ttree\Health\Result\ResultInterface`. You can use the builtin `ErrorResult`, `WarningResult` and `SuccessResult`.

*Currently the provided check contains "dummy" code. Real implementation will be done later when the architecture of the package is finished.*

How to create custom metrics endpoints ?
----------------------------------------

[](#how-to-create-custom-metrics-endpoints-)

TODO

Sponsors & Contributors
---------------------------

[](#sponsors--contributors)

The development of this package is sponsored by ttree ().

###  Health Score

16

—

LowBetter than 5% of packages

Maintenance14

Infrequent updates — may be unmaintained

Popularity9

Limited adoption so far

Community8

Small or concentrated contributor base

Maturity30

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.

### Community

Maintainers

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

---

Top Contributors

[![dfeyer](https://avatars.githubusercontent.com/u/221173?v=4)](https://github.com/dfeyer "dfeyer (5 commits)")

### Embed Badge

![Health badge](/badges/ttree-health/health.svg)

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

###  Alternatives

[lorisleiva/lody

Load files and classes as lazy collections in Laravel.

956.6M9](/packages/lorisleiva-lody)[nordcoders/laravel-service-maker

Generate services and contracts in Laravel with the artisan command

261.4k](/packages/nordcoders-laravel-service-maker)

PHPackages © 2026

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