Docker Swarm Monitor
Docker Swarm - Overview
Docker Swarm is Docker’s built-in clustering and orchestration solution that lets multiple Docker hosts work together as a single system. It helps you deploy, manage, and scale containerized applications across multiple machines, with a swarm manager coordinating the cluster and the participating systems acting as nodes.
Applications Manager enables effective Docker Swarm monitoring by providing visibility into cluster health, node status, and service performance, helping you identify and resolve issues faster. Learn more about Applications Manager’s container monitoring capabilities.
Creating a new Docker Swarm monitor
REST API to add a new Docker Swarm monitor: Click here
Once the prerequisites are fulfilled, follow the steps given below to create a new Docker Swarm monitor:
- Click on the New Monitor link.
- Select Docker Swarm under the Virtualization category.
- Specify a Display Name for the Docker Swarm monitor.
- Enter the Host Name/IP Address of the server where the Docker Swarm Manager is running.
- Enter the Port number used to access the Docker Swarm REST API.
- Choose the Credential Details option:
- If you select Use below credential, enter the User Name and Password required to access the Docker Swarm REST API.
- If you select Select from credential list, choose the appropriate credential from the preconfigured credential list.
- If the Docker Swarm REST API is accessed over SSL, enable the SSL is enabled option.
- (Optional) Select the Advanced Settings checkbox to configure additional options:
- Specify the Discovery Filter Regex to filter containers that are to be discovered and monitored. Only the containers that match the given regex will be added.
- Enable Client Certificate Authentication if client certificate—based authentication is configured on the Docker server.
- Specify the Polling Interval (in minutes) to determine how frequently Docker Swarm metrics are collected.
- (Optional) Choose a Monitor Group to associate this Docker Swarm monitor. You can associate it with multiple groups if required.
- Click Add Monitor(s) to complete the configuration.
This discovers all associated nodes and starts monitoring the nodes and containers in the Docker Swarm cluster.
Monitored Parameters
Go to the Monitors Category View by clicking the Monitors tab. Click on Docker Swarm under the Virtualization table. The Docker Swarm bulk configuration view is divided into three tabs:
- Availability tab gives the Availability history for the past 24 hours or 30 days.
- Performance tab gives the Health Status and events for the past 24 hours or 30 days.
- List view enables you to perform bulk admin configurations.
Click on the tabs listed below to view the corresponding metrics monitored:
Overview
| Parameter | Description | REST API Support | Prometheus Support |
|---|---|---|---|
| NODE OVERVIEWS | |||
| Total Worker Nodes | Total number of worker nodes available in the Docker Swarm cluster that execute application workloads. |  | |
| Total Manager Nodes | Total number of manager nodes responsible for managing the Docker Swarm cluster and orchestrating services. | | |
| RESPONSE TIME | |||
| Response Time | Time taken by the Docker Swarm REST API to respond to requests, indicating the overall responsiveness of the Swarm manager (in ms). | | |
| NODE DETAILS | |||
| Total Nodes | Total number of nodes (both manager and worker) present in the Docker Swarm cluster. | | |
| Active Nodes | Number of nodes that are currently active and available for scheduling and running services. | | |
| Inactive Nodes | Number of nodes that are currently unavailable or not responding within the Docker Swarm cluster. | | |
| CONTAINER OVERVIEW | |||
| Total Containers | Total number of containers discovered across all nodes in the Docker Swarm cluster. | | |
| Running Containers | Number of containers that are currently running and actively serving workloads. | | |
| Crashed Containers | Number of containers that have failed or exited unexpectedly due to errors or crashes. | | |
Node
| Parameter | Description | REST API Support | Prometheus Support |
|---|---|---|---|
| Node Details | |||
| Hostname | Name of the Docker Swarm node as identified within the cluster. | | |
| Role | Role assigned to the node in the Docker Swarm cluster, such as Manager or Worker. Manager nodes handle orchestration, while worker nodes run application workloads. | | |
| Availability | Current availability status of the node, indicating whether it is active and able to accept workloads. | | |
| Created At | Date and time when the node was added to the Docker Swarm cluster. | |  |
| Last Updated Time | Most recent date and time when the node’s status or configuration was updated. | | |
| Node Platform Details | |||
| OS Name | Operating system running on the Docker Swarm node. | | |
| Architecture | System architecture of the node, such as x86_64 or ARM. | | |
| Total CPU Processors | Total number of CPU processors available on the node. | | |
| Total Memory | Total physical memory available on the node (in GB). | | |
| Engine Version | Docker Engine version running on the node. | | |
Container
| Parameter | Description | REST API Support | Prometheus Support |
|---|---|---|---|
| Top 5 Memory Utilization | Graph showing the top 5 containers by memory utilization. | | |
| Top 5 CPU Utilization | Graph showing the top 5 containers by CPU utilization. | | |
| Container Details | |||
| Container Name | Name assigned to the container for identification. | | |
| State | Current runtime state of the container, such as Running, Exited, or Paused. | | |
| Image Name | Name of the container image used to create the container. | | |
| Network Mode | Network mode in which the container is running (for example, bridge, host, or overlay). | | |
| Restart Count | Total number of times the container has restarted. | | |
| Container Stats | |||
| Memory Utilization (%) | Percentage of memory currently utilized by the container. | | |
| CPU Utilization (%) | Percentage of CPU currently consumed by the container. | | |
| Bytes Received (KB) | Total amount of network data received by the container (in KB). | | |
| Bytes Transferred (KB) | Total amount of network data transferred (sent and received) by the container (in KB). | | |
| Container Timestamp Details | |||
| Exit Code | Exit status code returned when the container last stopped. | | |
| Created At | Date and time when the container was created. | | |
| Started At | Date and time when the container was last started. | | |
| Up Time | Total duration for which the container has been running since it was started. | | |
| Up Time (Hrs) | Total running time of the container expressed in hours. | | |
Service
| Parameter | Description | REST API Support | Prometheus Support |
|---|---|---|---|
| Services | |||
| Service Name | Name assigned to the Docker Swarm service. | | |
| Image Name | Container image used by the Docker Swarm service. | | |
| Protocol | Network protocol used by the service to communicate, such as TCP or UDP. | | |
| Endpoint Mode | Mode used to expose the service endpoints, such as VIP or DNSRR. | | |
| Replicas | Current number of service replicas running in the Docker Swarm. | | |
| Previous Replica Count | Number of replicas configured for the service before the most recent update. | | |
| Created At | Date and time when the Docker Swarm service was created. | | |
Configuration
| Parameter | Description | REST API Support | Prometheus Support |
|---|---|---|---|
| Swarm Name | Name assigned to the Docker Swarm cluster. | | |
| Task History Retention Limit | Number of completed task records retained by the Swarm manager for troubleshooting and auditing. | | |
| Snapshot Interval | Interval (in ticks) at which the Swarm manager takes state snapshots for recovery purposes. | | |
| Election Tick | Number of ticks used to determine leader election timeouts among Swarm managers. | | |
| Heartbeat Tick | Frequency (in ticks) at which heartbeat signals are sent between Swarm nodes to maintain cluster health. | | |
| Auto Lock Manager Enabled | Indicates whether automatic locking of the Swarm manager’s encryption keys is enabled. | | |
| Subnet Size | CIDR subnet size used for allocating IP addresses to Swarm services and containers. | | |
| UDP Port | UDP port used by Docker Swarm for node-to-node communication and cluster management. | | |
