Monitor the swarm status

Estimated reading time: 2 minutes

These are the docs for UCP version 2.2.22

To select a different version, use the selector below.

You can monitor the status of UCP by using the web UI or the CLI. You can also use the _ping endpoint to build monitoring automation.

Check status from the UI

The first place to check the status of UCP is the UCP web UI, since it shows warnings for situations that require your immediate attention. Administrators might see more warnings than regular users.

UCP dashboard

You can also navigate to the Nodes page, to see if all the nodes managed by UCP are healthy or not.

UCP dashboard

Each node has a status message explaining any problems with the node. In this example, a Windows worker node is down. Learn more about node status. Click the node to get more info on its status. In the details pane, click Actions and select Agent logs to see the log entries from the node.

Check status from the CLI

You can also monitor the status of a UCP cluster using the Docker CLI client. Download a UCP client certificate bundle and then run:

$ docker node ls

As a rule of thumb, if the status message starts with [Pending], then the current state is transient and the node is expected to correct itself back into a healthy state. Learn more about node status.

Monitoring automation

You can use the https://<ucp-manager-url>/_ping endpoint to check the health of a single UCP manager node. When you access this endpoint, the UCP manager validates that all its internal components are working, and returns one of the following HTTP error codes:

  • 200, if all components are healthy
  • 500, if one or more components are not healthy

If an administrator client certificate is used as a TLS client certificate for the _ping endpoint, a detailed error message is returned if any component is unhealthy.

If you’re accessing the _ping endpoint through a load balancer, you have no way to know which UCP manager node is not healthy, since any manager node might be serving your request. Make sure you’re connecting directly to the URL of a manager node, and not a load balancer. In addition, pinging the endpoint with a HEAD results in a 404 error code. Use a GET request instead.

Where to go next

UCP, troubleshoot, health, swarm