Docker Swarm

❗️

This source has been deprecated

observIQ is in the process of transitioning a subset of BindPlane's monitoring capabilities to the observIQ OpenTelemetry Collector. As a result, this Source is no longer publicly available in BindPlane. If you need access to this Source, please reach out to our support via chat or via [email protected].

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

NameRequired?Description
HostRequired
Port
Connection Timeout
SSL Configuration

Metrics

Node

NameDescription
Accepted Tasks CountAccepted Tasks Count
Allocated Tasks CountAllocated Tasks Count
ArchitectureArchitecture
Assigned Tasks CountAssigned Tasks Count
AvailabilityAvailability
Complete Tasks CountComplete Tasks Count
CPU Usage (Nanoseconds)CPU Usage
Created AtCreated At
Engine VersionEngine Version
Failed Tasks CountFailed Tasks Count
HostnameHostname
IDID
IP AddressIP Address
Memory Usage (Bytes)Memory Usage
Memory Utilization (%)Memory Utilization
NameName
Nano CPUs (Nanocores)Nano CPUs
New Tasks CountNew Tasks Count
Orphaned Tasks CountOrphaned Tasks Count
OSOS
Pending Tasks CountPending Tasks Count
Preparing Tasks CountPreparing Tasks Count
Rejected Tasks CountRejected Tasks Count
Remove Tasks CountRemove Tasks Count
RoleRole
Running Tasks CountRunning Tasks Count
Shutdown Tasks CountShutdown Tasks Count
Starting Tasks CountStarting Tasks Count
StateState
Total Memory (Bytes)Total Memory
Total Network ErrorsTotal Network Errors
Total Network Received (Bytes)Total Network Received
Total Network Sent (Bytes)Total Network Sent
Total Network TrafficTotal Network Traffic
Total Tasks CountTotal Tasks Count
Updated AtUpdated At

Service

NameDescription
Accepted Tasks CountAccepted Tasks Count
Allocated Tasks CountAllocated Tasks Count
Assigned Tasks CountAssigned Tasks Count
Complete Tasks CountComplete Tasks Count
Created AtCreated At
Failed Tasks CountFailed Tasks Count
IDID
ImageImage
Memory Limit (Bytes)Memory Limit
Memory Reserve (Bytes)Memory Reserve
ModeMode
NameName
Nano CPU Limit (Nanocores)Nano CPU Limit
Nano CPU Reserve (Nanocores)Nano CPU Reserve
New Tasks CountNew Tasks Count
Orphaned Tasks CountOrphaned Tasks Count
Pending Tasks CountPending Tasks Count
Preparing Tasks CountPreparing Tasks Count
Rejected Tasks CountRejected Tasks Count
Remove Tasks CountRemove Tasks Count
Replicas (Bytes)Replicas
Restart Policy ConditionRestart Policy Condition
Running Tasks CountRunning Tasks Count
Shutdown Tasks CountShutdown Tasks Count
Starting Tasks CountStarting Tasks Count
Total Tasks CountTotal Tasks Count
Updated AtUpdated At
VersionVersion

Swarm

NameDescription
Active Nodes CountActive Nodes Count
Created AtCreated At
Drained Nodes CountDrained Nodes Count
Election TickElection Tick
Global Services CountGlobal Services Count
Heartbeat Period (Nanoseconds)Heartbeat Period
Heartbeat TickHeartbeat Tick
IDID
Log Entries For Slow FollowersLog Entries For Slow Followers
Manager Nodes CountManager Nodes Count
NameName
Paused Nodes CountPaused Nodes Count
Replicated Services CountReplicated Services Count
Snapshot IntervalSnapshot Interval
Task History Retention LimitTask History Retention Limit
Total CPU Usage (Nanoseconds)Total CPU Usage
Total Memory Consumption (Bytes)Total Memory Consumption
Total Network ErrorsTotal Network Errors
Total Network Traffic (Bytes)Total Network Traffic
Total Nodes CountTotal Nodes Count
Total Services CountTotal Services Count
Total Tasks CountTotal Tasks Count
Updated AtUpdated At
VersionVersion
Worker Nodes CountWorker Nodes Count