Docker Swarm

Data Collection Setup

By default, the Docker Engine API runs on a Unix domain socket and it only allows connections on the host machine. When configured to listen on a TCP port, it requires only host:port information to connect, without any authentication.

The Docker daemon listens only on an HTTP port, and SSL is not used. Depending on the specific configuration, SSL can be configured behind a proxy. Certificate validation can be enforced, or not, using the connection parameters available.

Network Requirements

PORT (TCP): The port used for secure Docker client communication. Default: 2376

LPU

Docker Swarm HTTP API used for this data provider does not support authentication, or authorization.

Supported Versions

Data provider has been tested and works with Docker Engine API version 1.30
All previous versions are supported, as well

Connection Parameters

Name

Required?

Description

Host

Required

Port

Connection Timeout

SSL Configuration

Metrics

Node

Name

Description

Accepted Tasks Count

Accepted Tasks Count

Allocated Tasks Count

Allocated Tasks Count

Architecture

Architecture

Assigned Tasks Count

Assigned Tasks Count

Availability

Availability

Complete Tasks Count

Complete Tasks Count

CPU Usage (Nanoseconds)

CPU Usage

Created At

Created At

Engine Version

Engine Version

Failed Tasks Count

Failed Tasks Count

Hostname

Hostname

ID

ID

IP Address

IP Address

Memory Usage (Bytes)

Memory Usage

Memory Utilization (%)

Memory Utilization

Name

Name

Nano CPUs (Nanocores)

Nano CPUs

New Tasks Count

New Tasks Count

Orphaned Tasks Count

Orphaned Tasks Count

OS

OS

Pending Tasks Count

Pending Tasks Count

Preparing Tasks Count

Preparing Tasks Count

Rejected Tasks Count

Rejected Tasks Count

Remove Tasks Count

Remove Tasks Count

Role

Role

Running Tasks Count

Running Tasks Count

Shutdown Tasks Count

Shutdown Tasks Count

Starting Tasks Count

Starting Tasks Count

State

State

Total Memory (Bytes)

Total Memory

Total Network Errors

Total Network Errors

Total Network Received (Bytes)

Total Network Received

Total Network Sent (Bytes)

Total Network Sent

Total Network Traffic

Total Network Traffic

Total Tasks Count

Total Tasks Count

Updated At

Updated At

Service

Name

Description

Accepted Tasks Count

Accepted Tasks Count

Allocated Tasks Count

Allocated Tasks Count

Assigned Tasks Count

Assigned Tasks Count

Complete Tasks Count

Complete Tasks Count

Created At

Created At

Failed Tasks Count

Failed Tasks Count

ID

ID

Image

Image

Memory Limit (Bytes)

Memory Limit

Memory Reserve (Bytes)

Memory Reserve

Mode

Mode

Name

Name

Nano CPU Limit (Nanocores)

Nano CPU Limit

Nano CPU Reserve (Nanocores)

Nano CPU Reserve

New Tasks Count

New Tasks Count

Orphaned Tasks Count

Orphaned Tasks Count

Pending Tasks Count

Pending Tasks Count

Preparing Tasks Count

Preparing Tasks Count

Rejected Tasks Count

Rejected Tasks Count

Remove Tasks Count

Remove Tasks Count

Replicas (Bytes)

Replicas

Restart Policy Condition

Restart Policy Condition

Running Tasks Count

Running Tasks Count

Shutdown Tasks Count

Shutdown Tasks Count

Starting Tasks Count

Starting Tasks Count

Total Tasks Count

Total Tasks Count

Updated At

Updated At

Version

Version

Swarm

Name

Description

Active Nodes Count

Active Nodes Count

Created At

Created At

Drained Nodes Count

Drained Nodes Count

Election Tick

Election Tick

Global Services Count

Global Services Count

Heartbeat Period (Nanoseconds)

Heartbeat Period

Heartbeat Tick

Heartbeat Tick

ID

ID

Log Entries For Slow Followers

Log Entries For Slow Followers

Manager Nodes Count

Manager Nodes Count

Name

Name

Paused Nodes Count

Paused Nodes Count

Replicated Services Count

Replicated Services Count

Snapshot Interval

Snapshot Interval

Task History Retention Limit

Task History Retention Limit

Total CPU Usage (Nanoseconds)

Total CPU Usage

Total Memory Consumption (Bytes)

Total Memory Consumption

Total Network Errors

Total Network Errors

Total Network Traffic (Bytes)

Total Network Traffic

Total Nodes Count

Total Nodes Count

Total Services Count

Total Services Count

Total Tasks Count

Total Tasks Count

Updated At

Updated At

Version

Version

Worker Nodes Count

Worker Nodes Count