app:health:check¶

Check the health of all system components (database, Redis, the background worker, etc.) and report their status, latency, and details.

Quick start¶

Run from the installed-instance host shell with the dc function from Getting started. Paths name locations inside the application container.

dc exec app php bin/console app:health:check

Details¶

The command checks each system component and prints a table with the component name, status (OK, FAIL, or N/A), response latency in milliseconds, and any additional details.

The messenger row observes a shared consumer heartbeat. It reads N/A when Redis is unreachable, when no heartbeat has been seen by this observation process, or during a fresh stopped phase. A heartbeat that disappears after this process has seen it, an invalid heartbeat, or a stale heartbeat reads FAIL. Freshness allows 90 seconds for busy and 45 seconds for other phases. This signal does not prove that every consumer, the scheduler, the outbox relay or media execution is making progress. See Monitoring and Background work for those checks.

The exit status describes this container, so it leaves out the background worker and memory; the web server alerts administrators about those instead. If no other component is unhealthy, the command prints This container is healthy. and exits with code 0. If the worker or memory is unhealthy, it also prints a warning that names them as unhealthy but not counted toward this container. If any other component is unhealthy, it exits with code 1.

The command runs in its own PHP process, so the memory row measures that process against its memory_limit, not the web server's workers. The /health endpoint reports the workers.

This is the same check used by the Docker healthcheck, which the web image defines in Dockerfile and the development stack in docker-compose.yml.

Exit codes¶

Tips¶

• Use this as a quick diagnostic when something seems off — it checks connectivity to database and Redis in seconds.
• The Docker container healthcheck runs this command every 30 seconds.
• Use app:config:validate for additional configuration checks; neither command establishes complete background delivery.