From 1398c00fdca6ec08b953bbfe60002fc4653703b6 Mon Sep 17 00:00:00 2001 From: Dan Heath <76443935+Dan-Heath@users.noreply.github.com> Date: Thu, 7 Mar 2024 09:11:35 -0500 Subject: [PATCH] docs(worker): add information about worker status and health (#4487) (#4494) * docs(worker): add information about worker status and health --------- Co-authored-by: Dan Heath <76443935+Dan-Heath@users.noreply.github.com> Co-authored-by: Irena Rindos --- website/content/docs/concepts/workers.mdx | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/website/content/docs/concepts/workers.mdx b/website/content/docs/concepts/workers.mdx index c7550939c6..a2822c4a02 100644 --- a/website/content/docs/concepts/workers.mdx +++ b/website/content/docs/concepts/workers.mdx @@ -52,6 +52,14 @@ with tag “A,” to connect to targets in “Network A.” ![Boundary architecture example showing workers with tags](/img/worker-tags.png) +## Status and health +Boundary workers report their status to controllers on a regular basis. You can view the last time a worker reported its status in the +admin UI as **Last Seen** and in the CLI as the **Last Status Time**. If a worker hasn't reported status recently, it can be an +indication of an unhealthy worker. + +You can query the worker health endpoint to determine the health of a worker. The endpoint returns the worker state, active +session count, and connection state of the worker. For more information, refer to the [health endpoints](/boundary/docs/operations/health) documentation. + ## Multi-hop sessions This feature requires HCP Boundary or Boundary Enterprise