Bindplane

The Bindplane Developer Hub

Welcome to the Bindplane developer hub. You'll find comprehensive guides and documentation to help you start working with Bindplane as quickly as possible, as well as support if you get stuck. Let's jump right in!

Apache Mesos

Connection Parameters

Name
Required?
Description

Host

Required

The Master Node of the Apache Mesos Cluster to connect to.

Port

The port for communication to Apache Mesos REST API.

Username

Required

Password

Required

SSL Configuration

The SSL mode to use when connecting to the target. Can be configured to not use SSL (No SSL), use SSL but do not verify the target's certificate (No Verify), and use SSL and verify the target's certificate (Verify).

Connection Timeout (seconds)

The number of seconds to allow for connecting to the target.

Metrics

Agent

Name
Description

Active

Active

Allocated CPU Count

Allocated CPU Count

Allocated CPU Ratio (%)

Allocated CPU Ratio

Allocated Disk Space (Megabytes)

Allocated Disk Space

Allocated Disk Space Ratio (%)

Allocated Disk Space Ratio

Allocated GPU count

Allocated GPU count

Allocated GPUs (%)

Allocated GPUs

Allocated Memory (Megabytes)

Allocated Memory

Allocated Memory Ratio (%)

Allocated Memory Ratio

Allocated Revocable CPU Count

Allocated Revocable CPU Count

Allocated Revocable CPUs (%)

Allocated Revocable CPUs

Allocated Revocable Disk Space (Megabytes)

Allocated Revocable Disk Space

Allocated Revocable Disk Space Ratio (%)

Allocated Revocable Disk Space Ratio

Allocated Revocable GPU Count

Allocated Revocable GPU Count

Allocated Revocable GPUs (%)

Allocated Revocable GPUs

Allocated Revocable Memory (Megabytes)

Allocated Revocable Memory

Allocated Revocable Memory Ratio (%)

Allocated Revocable Memory Ratio

Available Disk Space (Megabytes)

Available Disk Space

Available Memory (Megabytes)

Available Memory

Container Destroy Errors

Container Destroy Errors

CPU Count

CPU Count

CPU Load 15 Minutes

CPU Load 15 Minutes

CPU Load 1 Minute

CPU Load 1 Minute

CPU Load 5 Minutes

CPU Load 5 Minutes

Failed Task Fetches

Failed Task Fetches

Failed Tasks Count

Failed Tasks Count

Fetcher Total Cache Size (Bytes)

Fetcher Total Cache Size

Fetcher Used Cache Size (Bytes)

Fetcher Used Cache Size

Finished Tasks Count

Finished Tasks Count

Free Memory (Bytes)

Free Memory

Garbage Collection Path Removal Failures

Garbage Collection Path Removal Failures

Garbage Collection Path Removal Successes

Garbage Collection Path Removal Successes

Garbage Collection Pending Path Removals

Garbage Collection Pending Path Removals

GPU Count

GPU Count

Hostname

Hostname

ID

ID

Killed Tasks Count

Killed Tasks Count

Lost Tasks Count

Lost Tasks Count

PID

PID

Port

Port

Registered

Registered

Registered Time (Nanoseconds)

Registered Time

Revocable CPU count

Revocable CPU count

Revocable Disk Space (Megabytes)

Revocable Disk Space

Revocable GPU Count

Revocable GPU Count

Revocable Memory (Megabytes)

Revocable Memory

Running Tasks Count

Running Tasks Count

Staging Tasks Count

Staging Tasks Count

Starting Tasks Count

Starting Tasks Count

Successful Task Fetches

Successful Task Fetches

Total Memory (Bytes)

Total Memory

Uptime (Seconds)

Uptime

Version

Version

Cluster

Name
Description

Active Agents Count

Active Agents Count

Active Frameworks Count

Active Frameworks Count

Agents Canceled Unreachable

Agents Canceled Unreachable

Agents Marked Unreachable

Agents Marked Unreachable

Agents Rejoined

Agents Rejoined

Agents Removed

Agents Removed

Agents Reregistered

Agents Reregistered

Agents Scheduled Unreachable

Agents Scheduled Unreachable

Allocated CPU Count

Allocated CPU Count

Allocated CPUs (%)

Allocated CPUs

Allocated Disk Space (Megabytes)

Allocated Disk Space

Allocated Disk Space Ratio (%)

Allocated Disk Space Ratio

Allocated GPU Count

Allocated GPU Count

Allocated GPUs (%)

Allocated GPUs

Allocated Memory (Megabytes)

Allocated Memory

Allocated Memory Ratio (%)

Allocated Memory Ratio

Allocated Revocable CPUs (%)

Allocated Revocable CPUs

Allocated Revocable CPUs Count

Allocated Revocable CPUs Count

Allocated Revocable Disk Space (%)

Allocated Revocable Disk Space

Allocated Revocable GPU Count

Allocated Revocable GPU Count

Allocated Revocable GPUs (%)

Allocated Revocable GPUs

Allocated Revocable Memory (Megabytes)

Allocated Revocable Memory

Allocated Revocable Memory Ratio (%)

Allocated Revocable Memory Ratio

Available Disk Space (Megabytes)

Available Disk Space

Available Memory (Megabytes)

Available Memory

Connected Agents Count

Connected Agents Count

Connected Frameworks Count

Connected Frameworks Count

Disconnected Agents Count

Disconnected Agents Count

Disconnected Frameworks Count

Disconnected Frameworks Count

Draining machines

Draining machines

Failed Tasks

Failed Tasks

Finished Tasks

Finished Tasks

Inactive Agents Count

Inactive Agents Count

Inactive Frameworks Count

Inactive Frameworks Count

Invalid Tasks

Invalid Tasks

Killed Tasks

Killed Tasks

Lost Tasks

Lost Tasks

Maintenance Windows

Maintenance Windows

Outstanding Resource Offers Count

Outstanding Resource Offers Count

Revocable CPUs Count

Revocable CPUs Count

Revocable Disk Space (Megabytes)

Revocable Disk Space

Revocable GPU Count

Revocable GPU Count

Revocable Memory (Megabytes)

Revocable Memory

Running Tasks

Running Tasks

Staging Tasks

Staging Tasks

Starting Tasks

Starting Tasks

Tasks Being Killed

Tasks Being Killed

Total CPU Count

Total CPU Count

Total GPU Count

Total GPU Count

Unreachable Tasks

Unreachable Tasks

Used Revocable Disk Space (Megabytes)

Used Revocable Disk Space

Container

Name
Description

Agent ID

Agent ID

CPU Limit

CPU Limit

CPU System Time (Seconds)

CPU System Time

CPU User Time (Seconds)

CPU User Time

Executor ID

Executor ID

Executor Name

Executor Name

Framework ID

Framework ID

ID

ID

Memory Limit (Bytes)

Memory Limit

Memory RSS (Bytes)

Memory RSS

Executor

Name
Description

Agent ID

Agent ID

Command Shell

Command Shell

Command value

Command value

Framework ID

Framework ID

ID

ID

Framework

Name
Description

Active

Active

Allocated CPU

Allocated CPU

Allocated Disk (Megabytes)

Allocated Disk

Allocated Memory (Megabytes)

Allocated Memory

Connected

Connected

Failover Timeout (Milliseconds)

Failover Timeout

Hostname

Hostname

ID

ID

Name

Name

Recovered

Recovered

User

The OS Account that is used by the Agent to run the Executors of this Framework.

Web UI URL

Web UI URL

Master

Name
Description

Build date

Build date

Build time

Build time

Build User

Build User

CPU Load 15 Minutes

CPU Load 15 Minutes

CPU Load 1 Minute

CPU Load 1 Minute

CPU Load 5 Minutes

CPU Load 5 Minutes

Elected Master

Elected Master

Elected Time (Seconds)

Elected Time

Free memory (Bytes)

Free memory

Git SHA

Git SHA

Git Tag

Git Tag

Healthy

Healthy

Hostname

Hostname

ID

ID

IP Address

IP Address

Log Level

Log Level

PID

PID

Port

Port

Start Time (Seconds)

Start Time

Total CPU Count

Total CPU Count

Total memory (Bytes)

Total memory

Uptime (Seconds)

The current time in seconds this master node has been running. A value consistently below 60 seconds indicates a flapping master node.

Version

Version

Quota

Name
Description

CPU

CPU

Disk (Megabytes)

Disk

Memory (Megabytes)

Memory

Principal

Principal

Role

Role

Role

Name
Description

CPU

CPU

Disk (Megabytes)

Disk

Memory (Megabytes)

Memory

Name

Name

Ports End

Ports End

Ports Start

Ports Start

Weight

Weight

Task

Name
Description

Agent ID

Agent ID

CPU

The amount of CPU allocated to this task. The units are seconds of CPU Time per second of wall clock time.

Disk (Megabytes)

Disk

Framework ID

Framework ID

ID

ID

Memory (Megabytes)

Memory

Name

Name

State

State

Status Update State

Status Update State

Status Update UUID

Status Update UUID

Weight

Name
Description

Amount

Amount

Role

Role