PHPackages                             t3n/flow-healthstatus - 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. t3n/flow-healthstatus

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

t3n/flow-healthstatus
=====================

\[ABANDONED\] Flow Framework package to check the health status of you application – check oniva/flow-healthstatus instead.

2.5.0(2y ago)630.1k↓30.6%5[2 issues](https://github.com/t3n/flow-healthstatus/issues)MITPHP

Since May 3Pushed 7mo ago9 watchersCompare

[ Source](https://github.com/t3n/flow-healthstatus)[ Packagist](https://packagist.org/packages/t3n/flow-healthstatus)[ RSS](/packages/t3n-flow-healthstatus/feed)WikiDiscussions master Synced 1mo ago

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

Warning

**This plugin is no longer being maintained. As replacement we suggest **

t3n.Flow.HealthStatus
=====================

[](#t3nflowhealthstatus)

Package to check the health status of a flow application.

It's extremly useful in a kubernetes environment to use with [readiness and liveness probe](https://kubernetes.io/docs/tasks/configure-pod-container/configure-liveness-readiness-probes/)to determine if a pod can serve traffic and if it is still alive.

Usage
-----

[](#usage)

To determine the current health status of your application you can check wether the app is ready or still alive.

### Readiness

[](#readiness)

Simply execute the flow command `./flow app:isready`.

This will execute all tests defined in the `t3n.Flow.HealthStatus.testChain` of the Settings.yaml. If all tests have passed, the `readyChain` tasks will be executed.

After a successfully run of the `readyChain` an internal lock will be set to prevent repeated execution. The `testChain` will be executed on every run. So the `readyChain` should bring your application in an "ready state". Make sure to initialize everything you need. The `testChain` should ping all services your application depends on.

### Liveness

[](#liveness)

Execute `./flow app:isalive` to check if your pod is still alive.

This will execute the `livenessChain`.

Currently the liveness chain is empty by default and has one possible test: `statusCode`.

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

[](#configuration)

Add all your tests in the following format in your apps Settings.yaml:

```
t3n:
  Flow:
    HealthStatus:
      testChain:
        yourUniqueTestKey:
          name: 'Optional name'
          test: 'database' // shorthand for a predefined task in t3n\Flow\HealthStatus\Test\*.Test or a full qualified class name
          options:
            key: 'value' // optional options for your test
          position: 'after otherTestKey' // optional position
```

After that, the check will execute the ready chain:

```
t3n:
  Flow:
    HealthStatus:
      readyChain:
        yourUniqueTaskKey:
          name: 'Optional name'
          task: 'command' // shorthand for a predefined task in t3n\Flow\HealthStatus\Task\*.Task or a full qualified class name
          options:
            key: 'value' // optional options for your task
          position: 'after otherTaskKey' / optional position
          lockName: 'mylock' // optional lock override. This will create a lock for this task only and ignore the global lock
```

After a successful ready chain invokation, you can call `./flow app:isalive` to execute your liveness chain:

```
t3n:
  Flow:
    HealthStatus:
      livenessChain:
        yourUniqueTestKey:
          name: 'Optional name'
          task: 'statusCode' // shorthand for a predefined task in t3n\Flow\HealthStatus\LivenessTest\*.Test or a full qualified class name
          options:
            key: 'value' // optional options for your task
          position: 'after otherTaskKey' / optional position
```

Advanced configuration
----------------------

[](#advanced-configuration)

Before each attempt to execute a ready task, the check will test the `t3n.Flow.HealthStatus.defaultReadyTaskCondition` to see if the task should be executed. In the default configuration this is simply a check to see if the ready lock is not yet set.

You can override this behaviour on a per task basis:

```
t3n:
  Flow:
    HealthStatus:
      readyChain:
        yourUniqueTaskKey:
          condition: '${Lock.isSet("mylock")}' // this can be any eel expression
          afterInvocation: '${Lock.set("mylock")}' // this will be executed after a successfull invocation
```

*(the `lockName` setting is simply a shorthand for exactly this example)*

To extend the eel context, you can provide additional helpers in `t3n.Flow.HealthStatus.defaultContext`.

Health status via HTTP-Request
------------------------------

[](#health-status-via-http-request)

If you'd like to check your Application via HTTP instead of a cli command you can do so by including the Routes in your `Routes.yaml`:

```
-
  name: 'Health-Routes'
  uriPattern: ''
  subRoutes:
    'HealthStatusSubroutes':
      package: 't3n.Flow.HealthStatus'
      variables:
        'healthStatusEndpoint': 'your-endpoint-name'
```

Afterwards there will be two new routes: `//ready` and `//live`Adjust the variable to your needs. Both endpoints will return a JSON formatted output. On a successful run the response has a status code 200 and if there are any errors the status code will be 500.

Example Configuration
---------------------

[](#example-configuration)

This example could be used in your Flow package to make sure that your application pod has a ready state to serve traffic. Therefore it will always check the ping status for doctrine, redis and beanstalk. On the first run all missing database migrations will be executed, the redis cache flushed and static resources published. After a successfull run only the testChain will be executed again.

```
t3n:
  Flow:
    HealthStatus:
      testChain:
        database:
          test: doctrine
          position: start
        redis:
          test: redis
          options:
            hostname: your-redis-host
        beanstalk:
          test: beanstalk
          options:
            hostname: your-beanstalk-host
      readyChain:
        migrations:
          task: command
          options:
            command: 'neos.flow:doctrine:migrate'
        flushRedis:
          name: 'Flush redis'
          position: 'start 100'
          task: redis
          options:
            hostname: your-redis-host
            command: FLUSHDB
            database: 0
        staticResources:
          name: 'Publish static resources'
          task: command
          position: 'end 20'
          lockname: staticresources
          cacheName: t3n_FlowHealthStatus_LocalLock
          options:
            command: 'neos.flow:resource:publish'
            arguments:
              collection: static
      livenessChain:
        home:
          test: statusCode
          name: 'Homepage responds'
          options:
            url: '/'
            method: 'GET'
            statusCode: 200
```

Note the `lockname` configuration. This Configuration enables you to run tasks only once per deployment or always. By default the `t3n_FlowHealthStatus_Lock` cache is used to read and write locks. Add this to your Caches.yaml and all your application pods will rely on the same lock files as they don't use the local file storage but redis. This will result in a execution once per deployment:

```
t3n_FlowHealthStatus_Lock:
  backend: Neos\Cache\Backend\RedisBackend
  backendOptions:
    hostname: 'your-redis-server'
    database: 2
```

The `staticResources` task has a custom cacheName configured. To ensure that this task will be executed in each application pod set it to local file storage:

```
t3n_FlowHealthStatus_LocalLock:
  frontend: Neos\Cache\Frontend\StringFrontend
  backend: Neos\Cache\Backend\FileBackend
```

###  Health Score

42

—

FairBetter than 90% of packages

Maintenance38

Infrequent updates — may be unmaintained

Popularity33

Limited adoption so far

Community19

Small or concentrated contributor base

Maturity67

Established project with proven stability

 Bus Factor1

Top contributor holds 52.8% 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 ~157 days

Recently: every ~280 days

Total

11

Last Release

991d ago

Major Versions

1.0.0 → 2.0.02019-11-22

1.0.x-dev → 2.1.02020-02-13

1.2.0 → 2.1.12020-07-29

### Community

Maintainers

![](https://avatars.githubusercontent.com/u/769789?v=4)[Johannes Steu](/maintainers/johannessteu)[@johannessteu](https://github.com/johannessteu)

---

Top Contributors

[![johannessteu](https://avatars.githubusercontent.com/u/769789?v=4)](https://github.com/johannessteu "johannessteu (28 commits)")[![das-nagnag](https://avatars.githubusercontent.com/u/5262896?v=4)](https://github.com/das-nagnag "das-nagnag (10 commits)")[![daniellienert](https://avatars.githubusercontent.com/u/642226?v=4)](https://github.com/daniellienert "daniellienert (7 commits)")[![Torsten85](https://avatars.githubusercontent.com/u/531361?v=4)](https://github.com/Torsten85 "Torsten85 (3 commits)")[![fl0uW](https://avatars.githubusercontent.com/u/69151846?v=4)](https://github.com/fl0uW "fl0uW (2 commits)")[![kdambekalns](https://avatars.githubusercontent.com/u/95873?v=4)](https://github.com/kdambekalns "kdambekalns (2 commits)")[![pagani-BETTERHOMES](https://avatars.githubusercontent.com/u/84859218?v=4)](https://github.com/pagani-BETTERHOMES "pagani-BETTERHOMES (1 commits)")

---

Tags

flowframeworkflowpackageneosneoscmsphp

### Embed Badge

![Health badge](/badges/t3n-flow-healthstatus/health.svg)

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

###  Alternatives

[neos/eel

The Embedded Expression Language (Eel) is a building block for creating Domain Specific Languages

122.0M27](/packages/neos-eel)[neos/form

Extensible and flexible API for building web forms

18853.0k40](/packages/neos-form)[neos/fusion-form

Fusion Form

19724.3k31](/packages/neos-fusion-form)[ttree/scheduler

Simple task scheduler for Neos Flow Framework

21108.8k1](/packages/ttree-scheduler)[avency/neos-vardump

Neos VarDump Package

147.1k](/packages/avency-neos-vardump)[flowpack/task

A Task scheduler for Neos Flow

1136.3k1](/packages/flowpack-task)

PHPackages © 2026

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