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!

Connection Parameters

Name
Required?
Description

Host

Required

The Mongos and/or Mongod to connect to.

Connecting To

Mongos Authentication

Mongos Username

Required

Mongos Password

Required

Mongod Authentication

Mongod Username

Required

Mongod Password

Required

Use SSL for Mongos

Use SSL for Mongod

Metrics

Cluster

Name
Description

Server Address List

List of server addresses the cluster uses to connect to the MongoDB environment

Configuration Server

Name
Description

Has Replica Set Child

Config Server Has a Replica Set as a Child.

Resource Name

Name of resource that serves as this cluster's config server

Database

Name
Description

Average Object Size (Bytes)

Average object size of this resource

Client Address

Client address that was used to retrieve this resource

Collections Average Object Size (Bytes)

Average size of objects in this resource's collections

Collections Count

Number of collections for this resource

Collections Documents Maximum

Maximum number of documents in this resource's collections

Collections Maximum Size (Bytes)

Maximum size of this resource's capped collections

Collections Objects Count

Number of objects or documents in this resource's collections

Collections Size (Bytes)

Size of all records in this resource's collections

Collections Storage Size (Bytes)

Storage size of all records in this resource's collections

Collections Total Index Size (Bytes)

Total size of all in this resource's collections

Collections Total Indexes

Number of indexes on this resource's collections

Data File Version

Data file version for this resource

Data Size (Bytes)

Data size of this resource

Disk Space Free (Bytes)

Amount of unused/free disk space

Extents

Number of extents for this resource

File Size (Bytes)

Total file size for this resource

Freelist Extents

Number of extents in the freelist for this resource

Freelist Extents Size (Bytes)

Size of the extents on the freelist for this resource

Index Size (Bytes)

Total index size for this resource

Indexes

Number of indexes for this resource

Name

Name of this resource

Namespace File Size (Megabytes)

Namespace file size for this resource

Objects

Number of objects for this resource

Storage Size (Bytes)

Storage size of this resource

Mongod

Name
Description

Advisory Host FQDNs

Advisory host fully qualified domain names of the machine hosting this resource

Arbiter Only

Indicates if this resource is an arbiter

Asserts: Message

Number of message assertions raised since the MongoDB process started

Asserts: Regular

Number of regular assertions raised since the MongoDB process started

Asserts: Rollovers

Number of rollovers since the MongoDB process started

Asserts: User

Number of user assertions that have occurred since the MongoDB process started

Asserts: Warning

Number of warnings raised since the MongoDB process started

Available Connections

Number of unused incoming connections available to this resource

Available Read Tickets

Amount of available read tickets

Available Write Tickets

Amount of available write tickets

Background Flushing Average (Milliseconds)

Average time for each flush to disk

Background Flushing Flushes

Number of times the databases on this resource has flushed all writes to disk

Background Flushing Last (Milliseconds)

Time it took the last flush operation to complete

Background Flushing Total (Milliseconds)

Time the mongod processes have spent writing data to disk

Build Indexes

Indicates if the mongod builds indexes on this resource

Collection Exclusive Lock Deadlocks

Number of times lock acquisitions with this mode encountered deadlocks

Collection Exclusive Lock Waits

Number of lock acquisitions with this mode waits because locks were held in a conflicting mode

Collection Exclusive Locks Acquired

Number of times the lock was acquired in this mode

Collection Exclusive Locks Time (Microseconds)

Cumulative wait time for lock acquisitions with this mode

Collection Intent Exclusive Lock Deadlocks

Number of times lock acquisitions with this mode encountered deadlocks

Collection Intent Exclusive Lock Waits

Number of lock acquisitions with this mode waits because locks were held in a conflicting mode

Collection Intent Exclusive Locks Acquired

Number of times the lock was acquired in this mode

Collection Intent Exclusive Locks Time (Microseconds)

Cumulative wait time for lock acquisitions with this mode

Collection Intent Shared Lock Deadlocks

Number of times lock acquisitions with this mode encountered deadlocks

Collection Intent Shared Lock Waits

Number of lock acquisitions with this mode waits because locks were held in a conflicting mode

Collection Intent Shared Locks Acquired

Number of times the lock was acquired in this mode

Collection Intent Shared Locks Time (Microseconds)

Cumulative wait time for lock acquisitions with this mode

Collection Shared Lock Deadlocks

Number of times lock acquisitions with this mode encountered deadlocks

Collection Shared Lock Waits

Number of lock acquisitions with this mode waits because locks were held in a conflicting mode

Collection Shared Locks Acquired

Number of times the lock was acquired in this mode

Collection Shared Locks Time (Microseconds)

Cumulative wait time for lock acquisitions with this mode

Command Count (Operations)

Number of database commands since mongod instance last started

Commits

Transactions written to journal during latest journal group commit interval

Commits In Write Lock

Commits that occurred while a write lock was held

Compressed Log Records (Records)

Total Amount of journaling compressed records since last checkpoint.

Compressed Log Records in Memory (Bytes)

Total memory used for storing compressed records.

Compressed Log Records Size (Bytes)

Total size of records compressed by WiredTiger since last checkpoint.

Compression Ratio

Compression Ratio of the data written to journal

Consolidated Logging (Bytes)

Amount of logging data consolidated.

Created Connections

Count of all incoming connections created to this resource

Current Cache (Bytes)

Amount of bytes currently in cache

Current Connections

Number of incoming connections to this resource

Cursor Timed Out

Total number of cursors that have timed out

Cursors Open

Total number of cursors this environment maintains

Data Journaled (Megabytes)

Data written to journal during latest journal group commit interval

Database Exclusive Lock Deadlocks

Number of times lock acquisitions with this mode encountered deadlocks

Database Exclusive Lock Waits

Number of lock acquisitions with this mode waits because locks were held in a conflicting mode

Database Exclusive Locks Acquired

Number of times the lock was acquired in this mode

Database Exclusive Locks Time (Microseconds)

Cumulative wait time for lock acquisitions with this mode

Database Intent Exclusive Lock Deadlocks

Number of times lock acquisitions with this mode encountered deadlocks

Database Intent Exclusive Lock Waits

Number of lock acquisitions with this mode waits because locks were held in a conflicting mode

Database Intent Exclusive Locks Acquired

Number of times the lock was acquired in this mode

Database Intent Exclusive Locks Time (Microseconds)

Cumulative wait time for lock acquisitions with this mode

Database Intent Shared Lock Deadlocks

Number of times lock acquisitions with this mode encountered deadlocks

Database Intent Shared Lock Waits

Number of lock acquisitions with this mode waits because locks were held in a conflicting mode

Database Intent Shared Locks Acquired

Number of times the lock was acquired in this mode

Database Intent Shared Locks Time (Microseconds)

Cumulative wait time for lock acquisitions with this mode

Database Shared Lock Deadlocks

Number of times lock acquisitions with this mode encountered deadlocks

Database Shared Lock Waits

Number of lock acquisitions with this mode waits because locks were held in a conflicting mode

Database Shared Locks Acquired

Number of times the lock was acquired in this mode

Database Shared Locks Time (Microseconds)

Cumulative wait time for lock acquisitions with this mode

Delay Behind Primary (Seconds)

Mongod delay behind the primary not accounting for the slave delay.

Delete Count (Operations)

Number of delete operations since mongod instance last started

Dirty Cache (Bytes)

Amount of dirty data (in bytes) in cache

Document Moves

Number of times documents have moved in the on-disk representation of the MongoDB data set

Documents Deleted

Number of documents deleted

Documents Inserted

Number of documents inserted

Documents Returned

Number of documents returned by queries

Documents Updated

Number of documents updated

Early Commits

Requested commits before the scheduled journal group commit interval

Extended Memory Supported

Indicates if the machine hosting this resource supports extended memory information

Fastmod Count (Operations)

Number of update operations that don't cause documents to grow nor require updates to the index

Flush Log Count (Operations)

Number of grouped commit to disk calls made.

Forced Log Write Count (Operations)

Amount of forced log write operations.

Forced Log Writes Skipped (Operations)

Amount of forced log write operations that were skipped.

Get More Count (Operations)

Number of "getmore" operations since mongod instance last started

Global Exclusive Lock Deadlocks

Number of times lock acquisitions with this mode encountered deadlocks

Global Exclusive Lock Waits

Number of lock acquisitions with this mode waits because locks were held in a conflicting mode

Global Exclusive Locks Acquired

Number of times the lock was acquired in this mode

Global Exclusive Locks Time (Microseconds)

Cumulative wait time for lock acquisitions with this mode

Global Intent Exclusive Lock Deadlocks

Number of times lock acquisitions with this mode encountered deadlocks

Global Intent Exclusive Lock Waits

Number of lock acquisitions with this mode waits because locks were held in a conflicting mode

Global Intent Exclusive Locks Acquired

Number of times the lock was acquired in this mode

Global Intent Exclusive Locks Time (Microseconds)

Cumulative wait time for lock acquisitions with this mode

Global Intent Shared Lock Deadlocks

Number of times lock acquisitions with this mode encountered deadlocks

Global Intent Shared Lock Waits

Number of lock acquisitions with this mode waits because locks were held in a conflicting mode

Global Intent Shared Locks Acquired

Number of times the lock was acquired in this mode

Global Intent Shared Locks Time (Microseconds)

Cumulative wait time for lock acquisitions with this mode

Global Lock Active Client Readers

Number of active client connections performing read operations

Global Lock Active Client Writers

Number of active client connections performing write operations

Global Lock Active Clients Total

Number of active client connections to the database

Global Lock Current Queue Readers

Number of operations currently queued and waiting for the read lock

Global Lock Current Queue Total

Number of operations queued waiting for the lock

Global Lock Current Queue Writers

Number of operations currently queued and waiting for the write lock

Global Lock Total Time (Microseconds)

Time since database last started and created the "globalLock"

Global Shared Lock Deadlocks

Number of times lock acquisitions with this mode encountered deadlocks

Global Shared Lock Waits

Number of lock acquisitions with this mode waits because locks were held in a conflicting mode

Global Shared Locks Acquired

Number of times the lock was acquired in this mode

Global Shared Locks Time (Microseconds)

Cumulative wait time for lock acquisitions with this mode

Heap Used (Bytes)

Heap used by this resources database processes

Hidden

Indicates if this resource is hidden by its replica set

Host Name

Hostname of the machine hosting this resource

ID

Name of this resource's replica set

Idhack Queries

Number of queries that contain the "_id" field

Insert Count (Operations)

Number of insert operations received since mongod instance last started

IO Wait Time (%)

Percentage of time waiting for lock acquisitions.

IP Address

IP address of the machine hosting this resource

Is Master

Indicates if this resource is writable

Is Recovering

Mongod is recovering from a delay.

Journal Mapped Memory (Megabytes)

Amount of mapped memory with journal by this resource's databases

Journaling Enabled

Signifies if Journaling is enabled

Log Buffer Size (Bytes)

WiredTiger total storage size of log buffer.

Log File Yields

Count of delayed journal writes waiting for previous log file to close.

Log Payload Size (Bytes)

Data size of log payload data.

Logs Record Scans (Scans)

Amount of records processed by log scan.

Log Records Scans Requiring Two Reads (Scans)

Amount of records requiring two reads when log scanned.

Log Scan Count (Operations)

Amount of log scan operations performed.

Log Server Thread Advances Last Sequence Number

Number of Log server thread advances write 'last sequence number' (LSN).

Log Synchronization Count (Operations)

Amount of log synchronization operations.

Log Synchronization Directory Count (Operations)

Amount of log synchronization directory operations.

Log Write Count (Operations)

Amount of log write operations.

Manually Zero Filled Log Files

Amount of log files manually zero-filled.

Mapped Memory (Megabytes)

Amount of mapped memory by this resource's databases

Maximum Log Size (Bytes)

Max size a log file can be before a new file is created.

Memory Architecture (Bits)

Architecture of the machine hosting this resource

Metadata Exclusive Lock Deadlocks

Number of times lock acquisitions with this mode encountered deadlocksNumber of times lock acquisitions with this mode encountered deadlocks

Metadata Exclusive Lock Waits

Number of lock acquisitions with this mode waits because locks were held in a conflicting mode

Metadata Exclusive Locks Acquired

Number of times the lock was acquired in this mode

Metadata Exclusive Locks Time (Microseconds)

Cumulative wait time for lock acquisitions with this mode

Metadata Intent Exclusive Lock Deadlocks

Number of times lock acquisitions with this mode encountered deadlocksNumber of times lock acquisitions with this mode encountered deadlocks

Metadata Intent Exclusive Lock Waits

Number of lock acquisitions with this mode waits because locks were held in a conflicting mode

Metadata Intent Exclusive Locks Acquired

Number of times the lock was acquired in this mode

Metadata Intent Exclusive Locks Time (Microseconds)

Cumulative wait time for lock acquisitions with this mode

Metadata Intent Shared Lock Deadlocks

Number of times lock acquisitions with this mode encountered deadlocksNumber of times lock acquisitions with this mode encountered deadlocks

Metadata Intent Shared Lock Waits

Number of lock acquisitions with this mode waits because locks were held in a conflicting mode

Metadata Intent Shared Locks Acquired

Number of times the lock was acquired in this mode

Metadata Intent Shared Locks Time (Microseconds)

Cumulative wait time for lock acquisitions with this mode

Metadata Shared Lock Deadlocks

Number of times lock acquisitions with this mode encountered deadlocksNumber of times lock acquisitions with this mode encountered deadlocks

Metadata Shared Lock Waits

Number of lock acquisitions with this mode waits because locks were held in a conflicting mode

Metadata Shared Locks Acquired

Number of times the lock was acquired in this mode

Metadata Shared Locks Time (Microseconds)

Cumulative wait time for lock acquisitions with this mode

MMAPv1 Journal Exclusive Lock Deadlocks

Number of times lock acquisitions with this mode encountered deadlocks

MMAPv1 Journal Exclusive Locks Acquired

Number of times the lock was acquired in this mode

MMAPv1 Journal Exclusive Locks Time (Microseconds)

Cumulative wait time for lock acquisitions with this mode

MMAPv1 Journal Intent Exclusive Lock Deadlocks

Number of times lock acquisitions with this mode encountered deadlocks

MMAPv1 Journal Intent Exclusive Lock Waits

Number of lock acquisitions with this mode waits because locks were held in a conflicting mode

MMAPv1 Journal Intent Exclusive Locks Acquired

Number of times the lock was acquired in this mode

MMAPv1 Journal Intent Exclusive Locks Time (Microseconds)

Cumulative wait time for lock acquisitions with this mode

MMAPv1 Journal Intent Shared Lock Deadlocks

Number of times lock acquisitions with this mode encountered deadlocks

MMAPv1 Journal Intent Shared Lock Waits

Number of lock acquisitions with this mode waits because locks were held in a conflicting mode

MMAPv1 Journal Intent Shared Locks Acquired

Number of times the lock was acquired in this mode

MMAPv1 Journal Intent Shared Locks Time (Microseconds)

Cumulative wait time for lock acquisitions with this mode

MMAPv1 Journal Lock Exclusive Waits

Number of lock acquisitions with this mode waits because locks were held in a conflicting mode

MMAPv1 Journal Shared Lock Deadlocks

Number of times lock acquisitions with this mode encountered deadlocks

MMAPv1 Journal Shared Lock Waits

Number of lock acquisitions with this mode waits because locks were held in a conflicting mode

MMAPv1 Journal Shared Locks Acquired

Number of times the lock was acquired in this mode

MMAPv1 Journal Shared Locks Time (Microseconds)

Cumulative wait time for lock acquisitions with this mode

Network Requests

Number of requests this resource has received

Network Traffic In (Bytes)

Bytes received by all databases of this resource

Network Traffic Out (Bytes)

Bytes sent from all databases of this resource

Oplog Exclusive Lock Deadlocks

Number of times lock acquisitions with this mode encountered deadlocks

Oplog Exclusive Lock Waits

Number of lock acquisitions with this mode waits because locks were held in a conflicting mode

Oplog Exclusive Locks Acquired

Number of times the lock was acquired in this mode

Oplog Exclusive Locks Time (Microseconds)

Cumulative wait time for lock acquisitions with this mode

Oplog Intent Exclusive Lock Deadlocks

Number of times lock acquisitions with this mode encountered deadlocks

Oplog Intent Exclusive Lock Waits

Number of lock acquisitions with this mode waits because locks were held in a conflicting mode

Oplog Intent Exclusive Locks Acquired

Number of times the lock was acquired in this mode

Oplog Intent Exclusive Locks Time (Microseconds)

Cumulative wait time for lock acquisitions with this mode

Oplog Intent Shared Lock Deadlocks

Number of times lock acquisitions with this mode encountered deadlocks

Oplog Intent Shared Lock Waits

Number of lock acquisitions with this mode waits because locks were held in a conflicting mode

Oplog Intent Shared Locks Acquired

Number of times the lock was acquired in this mode

Oplog Intent Shared Locks Time (Microseconds)

Cumulative wait time for lock acquisitions with this mode

Oplog Shared Lock Deadlocks

Number of times lock acquisitions with this mode encountered deadlocks

Oplog Shared Lock Waits

Number of lock acquisitions with this mode waits because locks were held in a conflicting mode

Oplog Shared Locks Acquired

Number of times the lock was acquired in this mode

Oplog Shared Locks Time (Microseconds)

Cumulative wait time for lock acquisitions with this mode

Optime

Optime of the mongod

Out Read Tickets

Amount of out read tickets

Out Write Tickets

Amount of out write tickets

Page Faults

Total number of page faults

PID

Process ID number on this resource

Preallocated Log Files Queued

Amount of pre-allocated log files queued to write to disk.

Preallocated Log Files Used

Amount of pre-allocated log files used.

Preallocated Prepared Log Files

Amount of pre-allocated log files prepared to write to disk.

Preallocated Unready Log Files

Amount of pre-allocated log files that are not ready and missed.

Priority

Signifies eligibility of this resource to become primary

Process

Current MongoDB process on this resource

Query Count (Operations)

Number of queries received since mongod instance last started

Read Cache (Bytes)

Amount of bytes read into cache

Read Tickets

Amount of total read tickets

Release Advances Last Sequence Number

Log release advances write 'last sequence number' (LSN).

Replication Command Count (Operations)

Number of replicated database commands since mongod instance last started

Replication Delete Count (Operations)

Number of replicated delete operations since mongod instance last started

Replication Get More Count (Operations)

Number of "getmore" operations since mongod instance last started

Replication Insert Count (Operations)

Number of replicated insert operations received since mongod instance last started

Replication Query Count (Operations)

Number of replicated queries received since mongod instance last started

Replication Update Count (Operations)

Number of replicated update operations received since mongod instance last started

Resident Memory (Megabytes)

Amount of RAM used by this resource's database processes

Shares Host With Other Mongod

Mongod Shares a Host with another Mongod. 1 if it shares, 0 if it does not share.

Slave Delay (Seconds)

Intentional lag time behind the primary of this resource's replica set

Slots Coalesced (Writes)

Amount of written slots coalesced.

Sort Queries

Number of queries that return sorted numbers that cannot perform the sort operation using an index

SSL Certificate Expiration Date

Expiration date of the TLS/SSL certificate

SSL Certificate Subject Name

Subject name associated with TLS/SSL certificate

SSL Has Certificate Authority

Indicates if the TLS/SSL certificate is associated with a certificate authority

State

Current state of the mongod in the replica set

Storage Engine Name

Name of the current storage engine

Storage Engine Persistent

Indicates if the storage engine persists data to disk

Storage Engine Supports Committed Reads

Indicates if the storage engine supports "majority" read concern

Switch Slot Attempts (Attempts)

Amount of busy returns attempting to switch slots.

Tags

Document that describe the replica sets settings

Too Small Uncompressed Log Records (Records)

Number of journal records uncompressed because they were 128 bytes or smaller in size.

Uncompressed Log Records (Records)

Total number of uncompressed journal log records since last checkpoint.

Update Count (Operations)

Number of update operations received since mongod instance last started

Uptime (Seconds)

Time the current MongoDB process has been active

Version

Version of the current MongoDB process

Virtual Memory (Megabytes)

Virtual memory being used by the mongod process

Votes

Number of votes this resource will have in a replica set election

Write Backs Queued

Indicates if there are operations from a mongos instance queued for retrying

Write Conflict Queries

Number of queries that encountered write conflicts

Write Lock (%)

Percentage of writes encountered locks.

Write Tickets

Amount of total write tickets

Written Cache (Bytes)

Amount of bytes written from cache

Written Log Data (Bytes)

Amount of data written to logs using WiredTiger storage engine since last checkin.

Written to Data Files (Megabytes)

Data written from journal during latest journal group commit interval

Mongos

Name
Description

Advisory Host FQDNs

Advisory host fully qualified domain names of the machine hosting this resource

Asserts: Message

Number of message assertions raised since the MongoDB process started

Asserts: Regular

Number of regular assertions raised since the MongoDB process started

Asserts: Rollovers

Number of rollovers since the MongoDB process started

Asserts: User

Number of user assertions that have occurred since the MongoDB process started

Asserts: Warning

Number of warnings raised since the MongoDB process started

Available Connections

Number of unused incoming connections available to this resource

Background Flushing: Average (Milliseconds)

Average time for each flush to disk

Background Flushing: Flushes

Number of times the databases on this resource has flushed all writes to disk

Background Flushing: Last (Milliseconds)

Time it took the last flush operation to complete

Background Flushing: Total (Milliseconds)

Time the mongod processes have spent writing data to disk

Command Count (Operations)

Number of database commands since mongod instance last started

Connections Used Over Available (%)

The percent of connections being used.

Created Connections

Count of all incoming connections created to this resource

Current Connections

Number of incoming connections to this resource

Delete Count (Operations)

Number of delete operations since mongod instance last started

Extended Memory Supported

Indicates if the machine hosting this resource supports extended memory information

Get More Count (Operations)

Number of "getmore" operations since mongod instance last started

Heap Used (Bytes)

Heap used by this resources database processes

Host Name

Hostname of the machine hosting this resource

Insert Count (Operations)

Number of insert operations received since mongod instance last started

IP Address

IP address of the machine hosting this resource

Journal Mapped Memory (Megabytes)

Amount of mapped memory with journal by this resource's databases

Mapped Memory (Megabytes)

Amount of mapped memory by this resource's databases

Memory Architecture (Bits)

Architecture of the machine hosting this resource

Network Requests

Number of requests this resource has received

Network Traffic In (Bytes)

Bytes received by all databases of this resource

Network Traffic Out (Bytes)

Bytes sent from all databases of this resource

Page Faults

Total number of page faults

Page Faults to Operations Ratio

The ratio of Page Faults to Operations.

Page Faults to Operations Ratio Greater Than 1

The ratio of Page Faults to Operations is greater than or equal to one.

PID

Process ID number on this resource

Process

Current MongoDB process on this resource

Query Count (Operations)

Number of queries received since mongod instance last started

Resident Memory (Megabytes)

Amount of RAM used by this resource's database processes

Update Count (Operations)

Number of update operations received since mongod instance last started

Uptime (Seconds)

Time the current MongoDB process has been active

Version

Version of the current MongoDB process

Virtual Memory (Megabytes)

Virtual memory being used by the mongod process

Replica Set

Name
Description

Chaining Allowed

Indicated if chaining is supported on this resource

Data Bearing Nodes

Number of Data Bearing Mongods that are not Arbiters.

Election ID

Election ID of this resource

Election Timeout (Milliseconds)

Duration of this resource's election timeout

Heartbeat Interval (Milliseconds)

Frequency of this resource's heartbeats

Heartbeat Timeout (Seconds)

Duration of this resource's heartbeat timeout

ID

ID for this resource

Last Error Default

Last error default of this resource

Last Error Modes

Last error modes of this resource

Odd Votes Count

Replica Set odd votes. 1 if odd, 0 if even.

Oplog Time (Seconds)

window of time before the writes that occurred on the primary will go out of scope for secondary replication.

Primary Replication

Indicates this resource is a primary replication set

Protocol Version

Protocol version of this resource

Replication Arbiters

List of arbiters within this replication set

Replication Hosts

List of hosts within this replication set

Replication Rollback ID

Rollback ID of this resource

Request Votes

Total request votes in a replica set

State

State of this resource

Version

Version of MongoDB this resource has

Shard

Name
Description

Has Replica Set Child

Shard Has a Replica Set as a Child.

Host

Host of this resource

Version

Shard version of this resource