Health property/method for Container object

Is it possible to provide some properties or methods related to HEALTHCHECK in Container object? This is convenient to know the HEALTHCHECK result by using much simpler way rather than just calling Low-level API inspect_container.

I found someone had proposed before https://github.com/docker/docker-py/pull/1726 but it’s long time ago, so is there any plan?

---

And I think it is great if there is a method Container.raise_for_health(timeout) that can check container itself whether it is healthy or not until timeout. The spec may like below:

1. Return None when it changes to healthy status before timeout
2. Raise HealthCheckError exception when it changes to unhealthy status before timeout
3. Raise HealthCheckTimeout exception when it reaches the timeout (still starting status)

Then, the client usage will like,

client = docker.from_env()
container = client.containers.run('nginx', healthcheck={'test': 'curl localhost'})
container.raise_for_health(timeout=60)

[maiamccormick-toast]

I get the reasoning for not supporting health check result as a container property, but in case another datapoint is useful, this functionality would make a LOT of sense for my current project. (We got it working with @roblevy’s hack linked above, but it’s weird from a readability/code ergonomics perspective to have a separate docker API client for something you expect to be supported by the SDK.)

[roblevy]

FYI, I’ve hacked together a response to this SO question before I knew that you’d already rejected the idea of waiting on a health check.

For things like database engines, waiting on a health check is vital because the container will be “Started” long before the database is up and running.