From c57d6ed4f0c862f3c8dd92c9c61e08791664c9d8 Mon Sep 17 00:00:00 2001 From: Amir Raminfar Date: Sun, 3 Nov 2024 14:43:25 -0800 Subject: [PATCH] docs: fix healthcheck page --- docs/guide/healthcheck.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/docs/guide/healthcheck.md b/docs/guide/healthcheck.md index 189dac7c..313e0f7b 100644 --- a/docs/guide/healthcheck.md +++ b/docs/guide/healthcheck.md @@ -2,7 +2,7 @@ title: Healthcheck --- -# Adding healthcheck +# Enabling healthcheck Dozzle has internal support for healthcheck using `dozzle healthcheck` command. It is not enabled by default as it adds extra CPU usage. To use `healthcheck` you need to configure it. Below is an example that checks the health of Dozzle every 3 seconds. @@ -21,3 +21,8 @@ services: retries: 5 start_period: 30s ``` + +`dozzle healthcheck` skips agents as they are not required for healthcheck. Agents can be configured to have their own [healthcheck](/guide/agent#setting-up-healthcheck). + +> [!WARNING] +> The `healthcheck` command does not work with `--health-cmd` flag due to a bug in Docker. You need to use the `healthcheck` configuration in the `docker-compose.yml` file. See [Docker issue](https://github.com/docker/cli/issues/3719) for more information.