docker_health
Read-only
Check Docker health from three angles: container healthcheck verdicts, daemon responsiveness, and configured host profiles. Each result explains its own meaning, including services with no healthcheck.
Instructions
services says whether the containers answer their healthchecks, server whether this process is well, profiles which Docker hosts it was given. The word healthy means something different in each branch, so every answer explains its own verdict. A service that declares no healthcheck is said to have none, not counted as sick.
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| action | Yes | services: what each container says about itself through its own healthcheck. server: whether the daemon answers this server and what it knows about itself. profiles: the hosts it was configured with, read from the configuration and not connected to. | |
| profile | No | Which Docker host, by profile name. Default: the profile marked as default. | |
| project | No | Which compose project. Default: the project of the working directory. A name matching nothing is an error, not a fall back to every container on the host. | |
| services | No | Only these services, for action services. Default: every container of the project. | |
| compose_path | No | Where the compose file is: the file itself, or the directory holding it. Needed only when no container of the host carries the project label — a project that was never brought up there. A directory holding several compose files is refused with their names rather than guessed through. |
Output Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| action | No | ||
| broken | No | ||
| legend | No | What the words in this answer mean. A key names the field before the value — "state=running", "containers[].health=unhealthy" — and only the values this answer used are listed. | |
| reason | No | ||
| server | No | ||
| source | No | ||
| overall | No | ||
| project | No | ||
| profiles | No | ||
| services | No |