shel/neos-healthcheck

Rest endpoint to check the health and customisable metrics of a Neos CMS instance

0.0.1 2025-05-13 05:22 UTC

Requires

• neos/neos: ^8.3

Suggests

• flownative/token-authentication: To use the token authentication feature, install flownative/token-authentication

MIT

• Sebastian Helzle

• flow
• Neos
• neoscms
• healthcheck

README

Installation

Install the package via composer:

composer require shel/neos-healthcheck

Example output of the endpoint

The package includes various implementations of the Shel\Neos\HealthCheck\Checks\HealthCheckInterface which are executed when the endpoint is called. In addition several of them provide configuration options to customize their behavior.

{
    "status": "ok",
    "message": "The system is healthy.",
    "timestamp": 1747112482,
    "packageVersions": {
        "Neos.Neos": "8.3.23",
        "Neos.Neos.Ui": "8.3.13"
    },
    "releaseDate": "2025-05-13 06:39:00",
    "releaseVersion": "5.4.1",
    "phpConfiguration": {
        "memory_limit": "4096M",
        "max_execution_time": "0",
        "max_input_time": "60",
        "post_max_size": "200M",
        "upload_max_filesize": "200M"
    }
}

Accessing the endpoint

The JSON endpoint /healthcheck is secured by default, so you need to provide a mechanism to authenticate the request.

The recommended way is to install the package flownative/token-authentication and create a token for the role Shel.Neos.HealthCheck:Client:

Run

./flow hashtoken:createhashtoken --roleNames Shel.Neos.HealthCheck:Client

This will create a token which you can use to authenticate the request either as request argument _authenticationHashToken=<myToken> or as Authorization header with the value Bearer <myToken>.

Configuration

You can configure some of the individual checks in your Settings.yaml file. See Configuration/Settings.HealthChecks.yaml for the available options.

License

See the LICENSE.txt file for details.