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!

All Metrics

Metrics

Configuration

NameDescription
Additional InfoAdditional, more detailed, description of the parameter
Boot ValueParameter value assumed at server startup if the parameter is not otherwise set
CategoryLogical group of the parameter
ContextContext required to set the parameter's value
Current valueCurrent value of the parameter
DescriptionA brief description of the parameter
Maximum ValueMaximum allowed value of the parameter (null for non-numeric values)
Minimum ValueMinimum allowed value of the parameter (null for non-numeric values)
NameRun-time configuration parameter name
Reset ValueValue that RESET would reset the parameter to in the current session
SourceSource of the current parameter value
UnitImplicit unit of the parameter
Value TypeParameter type (bool, enum, integer, real, or string)

Database

NameDescription
Active Connections (Sessions)Number of backends currently connected to this database
Active Sessions (Sessions)Backends that are currently executing a query
Block Reads (Reads)Number of disk blocks read in this database
Buffer Hit Ratios (%)Ratio of read buffer hits to total reads
Buffer Hits (Reads)Number of times disk blocks were found already in the buffer cache, so that a read was not necessary (this only includes hits in the PostgreSQL buffer cache, not the operating system's file system cache)
Deadlocks (Locks)Number of deadlocks detected in this database
Disabled Sessions (Sessions)Backends that have track_activities disabled
Fastpath Function Call Sessions (Sessions)Backends that are currently executing a fast-path function
IDOID of the database
Idle in (Aborted) Transaction Sessions (Sessions)Backends that are currently in a transaction, not executing a query, and a statement in the transaction has caused an error
Idle In Transaction Sessions (Sessions)Backends that are currently in a transaction, but not executing a query
Idle Sessions (Sessions)Backends that are currently awaiting a new client command
Latest Stats ResetTime at which these statistics were last reset
NameName of the database
Queries Canceled Due to ConflictsNumber of queries canceled due to conflicts with recovery in this database. (Conflicts occur only on standby servers, see pg_stat_database_conflicts for details.)
Queries Canceled Due to DeadlocksNumber of queries in this database that have been canceled due to deadlocks
Queries Canceled Due to Dropped TablespacesNumber of queries in this database that have been canceled due to dropped tablespaces
Queries Canceled Due to Lock TimeoutsNumber of queries in this database that have been canceled due to lock timeouts
Queries Canceled Due to Old SnapshotsNumber of queries in this database that have been canceled due to old snapshots
Queries Canceled Due to Pinned BuffersNumber of queries in this database that have been canceled due to pinned buffers
Rows Deleted (Rows)Number of rows deleted by queries in this database
Rows Fetched (Rows)Number of rows fetched by queries in this database
Rows Inserted (Rows)Number of rows inserted by queries in this database
Rows Returned (Rows)Number of rows returned by queries in this database
Rows Updated (Rows)Number of rows updated by queries in this database
Sequence Blocks Hit (Blocks)Number of disk blocks read from all sequences in this database
Sequence Blocks Read (Blocks)Number of buffer hits from all sequences in this database
Size (Bytes)Disk space used by the database
Tablespace NameName of the default tablespace for the database. Within this database, all tables for which pg_class.reltablespace is zero will be stored in this tablespace. In particular, all the non-shared system catalogs will be there.
Temporary Data Written (Bytes)Total amount of data written to temporary files by queries in this database. All temporary files are counted, regardless of why the temporary file was created, and regardless of the log_temp_files setting.
Temporary Files CreatedNumber of temporary files created by queries in this database. All temporary files are counted, regardless of why the temporary file was created (e.g., sorting or hashing), and regardless of the log_temp_files setting.
Time Spent Reading Data (Milliseconds)Time spent reading data file blocks by backends in this database
Time Spent Writing Data (Milliseconds)Time spent writing data file blocks by backends in this database
Transactions Committed (Transactions)Number of transactions in this database that have been committed
Transactions Rolled Back (Transactions)Number of transactions in this database that have been rolled back
Waiting Sessions (Sessions)Backends that are currently waiting on a lock

Function

NameDescription
Average Time (Milliseconds)Average time spent in this function and all other functions called by it
Calls (Calls)Number of times this function has been called
Database NameName of the database the function is in
IDOID of the function
NameName of the function
RankCurrent rank of the function as ordered by consumer request (order_functions_by parameter)
Schema NameName of the schema the function is in
Self Time (Milliseconds)Total time spent in this function itself, not including other functions called by it
Total Time (Milliseconds)Total time spent in this function and all other functions called by it

Index

NameDescription
Block Reads (Reads)Number of disk blocks read from this index
Buffer Hits (Reads)Number of buffer hits for this index
Entries Returned (Rows)Number of index entries returned by scans on this index
IDOID of the index
NameName of the index
Scans (Scans)Number of index scans initiated on this index
Schema NameName of the schema the index is in
Table IDOID of the table for the index
Table NameName of the table for the index
Table Rows Fetched (Fetches)Number of live table rows fetched by simple index scans using this index

Instance

NameDescription
Buffers AllocatedNumber of buffers allocated
Buffers Written by BackendNumber of buffers written directly by a backend
Buffers Written by Background WriterNumber of buffers written by the background writer
Buffers Written During CheckpointNumber of buffers written during checkpoints
Estimated Replication Delay (Seconds)Time since last replayed transaction timestamp from the replication master
HostHost name of instance
Last Replay TimestampGet time stamp of last transaction replayed during recovery. This is the time at which the commit or abort WAL record for that transaction was generated on the primary. If no transactions have been replayed during recovery, this function returns NULL. Otherwise, if recovery is still in progress this will increase monotonically. If recovery has completed then this value will remain static at the value of the last transaction applied during that recovery
Last WAL File Archive FailedName of the WAL file of the last failed archival operation
Last WAL File Archive Failed TimeTime of the last failed archival operation
Last WAL File Archive TimeTime of the last successful archive operation
Last WAL File ArchivedName of the last WAL file successfully archived
Latest Stats ResetTime at which these statistics were last reset
NameIP Address and port on which the server accepted the monitoring connection
Requested Checkpoints Performed (Checkpoints)Number of requested checkpoints that have been performed
Scheduled Checkpoints Performed (Checkpoints)Number of scheduled checkpoints that have been performed
Server IPIP address on which the server accepted the monitoring connection
Server PortPort on which the server accepted the monitoring connection
Time Synchronizing Checkpoint Files to Disk (Milliseconds)Total amount of time that has been spent in the portion of checkpoint processing where files are synchronized to disk
Time Writing Checkpoint Files to Disk (Milliseconds)Total amount of time that has been spent in the portion of checkpoint processing where files are written to disk
Times Backend Executed Own fsyncNumber of times a backend had to execute its own fsync call (normally the background writer handles those even when the backend does its own write)
Times Background Writer Stopped Due to too Many BuffersNumber of times the background writer stopped a cleaning scan because it had written too many buffers
VersionPostgreSQL version information
WAL File Archives FailedNumber of failed attempts for archiving WAL files
WAL Files ArchivedNumber of WAL files that have been successfully archived

Query

NameDescription
Average Time (Milliseconds)Average time spent in the statement per execution
Calls (Calls)Number of times executed
Database NameName of the database in which the statement was executed
IDInternal hash code, computed from the statement's parse tree
Local Block Cache Hits (Reads)Total number of local block cache hits by the statement
Local Blocks Dirtied (Blocks)Total number of local blocks dirtied by the statement
Local Blocks Read (Blocks)Total number of local blocks read by the statement
Local Blocks Written (Blocks)Total number of local blocks written by the statement
RankCurrent rank of the statement as ordered by consumer request (order_queries_by parameter). If order_queries_by is set to 'all', then this metric is ambiguous.
Rows (Rows)Total number of rows retrieved or affected by the statement
Shared Block Cache Hits (Reads)Total number of shared block cache hits by the statement
Shared Blocks Dirtied (Blocks)Total number of shared blocks dirtied by the statement
Shared Blocks Read (Blocks)Total number of shared blocks read by the statement
Shared Blocks Written (Blocks)Total number of shared blocks written by the statement
TextText of a representative statement or query ID
Total Time (Milliseconds)Total time spent in the statement
Total Time Reading Blocks (Milliseconds)Total time the statement spent reading blocks (if track_io_timing is enabled, otherwise zero)
Total Time Writing Blocks (Milliseconds)Total time the statement spent writing blocks (if track_io_timing is enabled, otherwise zero)
UsernameName of the user who executed the statement

Query Plan

NameDescription
PlanJSON representation of the query execution plan.

Replication

NameDescription
Application NameName of the application that is connected to this WAL sender
Client HostnameHost name of the connected client, as reported by a reverse DNS lookup of client_addr. This field will only be non-null for IP connections, and only when log_hostname is enabled.
Client IPIP address of the client connected to this WAL sender. If this field is null, it indicates that the client is connected via a Unix socket on the server machine.
Client PortTCP port number that the client is using for communication with this WAL sender, or -1 if a Unix socket is used
Delay (Bytes)Amount of data that has not been replayed into database on the standby server
Last Transaction Log Position Flushed to DiskLast transaction log position flushed to disk by this standby server
Last Transaction Log Position Replayed into DatabaseLast transaction log position replayed into the database on this standby server
Last Transaction Log Position SentLast transaction log position sent on this connection
Last Transaction Log Position Written to DiskLast transaction log position written to disk by this standby server
Oldest Transaction ID Seen for ProcessThis standby's xmin horizon reported by hot_standby_feedback
PIDProcess ID of a WAL sender process
Priority of Standby ServerPriority of this standby server for being chosen as the synchronous standby
Process Start TimeTime when this process was started, i.e., when the client connected to this WAL sender
StateCurrent WAL Sender State
Synchronous State of ServerSynchronous state of this standby server
User IDOID of the user logged into this WAL sender process
UsernameName of the user logged into this WAL sender process

Sequence

NameDescription
Blocks Read (Blocks)Number of disk blocks read from this sequence
Buffer Hits (Reads)Number of buffer hits for this sequence
Database NameName of the database the sequence is in
IDOID of the sequence
NameName of the sequence
Schema NameName of the schema the sequence is in

Session

NameDescription
Application NameName of the application that is connected to this backend
Backend Connect TimeTime when this process was started, i.e., when the client connected to the server
Backend is currently waiting on a lockTrue if this backend is currently waiting on a lock
Backend Transaction IDTop-level transaction identifier of this backend, if any.
Client HostnameHost name of the connected client, as reported by a reverse DNS lookup of client_addr. This field will only be non-null for IP connections, and only when log_hostname is enabled.
Client IPIP address of the client connected to this backend. If this field is null, it indicates either that the client is connected via a Unix socket on the server machine or that this is an internal process such as autovacuum.
Client PortTCP port number that the client is using for communication with this backend, or -1 if a Unix socket is used
Current Backend StateCurrent overall state of this backend
Current Query Start TimeTime when the currently active query was started, or if state is not active, when the last query was started
Current Transaction Start TimeTime when this process' current transaction was started, or null if no transaction is active. If the current query is the first of its transaction, this column is equal to the query_start column.
Database IDOID of the database this backend is connected to
Database NameName of the database this backend is connected to
Last State Change TimeTime when the state was last changed
NameName of the user and application connected to this backend
Oldest Transaction ID Seen for BackendThe current backend's xmin horizon.
PIDProcess ID of the backend
Query TextText of this backend's most recent query. If state is active this field shows the currently executing query. In all other states, it shows the last query that was executed.
User IDOID of the user logged into this backend
UsernameName of the user logged into this backend

Table

NameDescription
Analyzes by Auto DaemonNumber of times this table has been analyzed by the autovacuum daemon
Blocks Read (Blocks)Number of disk blocks read from the table
Blocks Read from Indexes (Blocks)Number of disk blocks read from all indexes on this table
Blocks Read from TOAST Table (Blocks)Number of disk blocks read from this table's TOAST table (if any)
Blocks Read from TOAST Table Indexes (Blocks)Number of disk blocks read from this table's TOAST table indexes (if any)
Buffer Hits from Indexes (Blocks)Number of buffer hits in all indexes on this table
Buffer Hits from TOAST Table (Blocks)Number of buffer hits in this table's TOAST table (if any)
Buffer Hits from TOAST Table Indexes (Blocks)Number of buffer hits in this table's TOAST table indexes (if any)
Buffer Reads (Blocks)Number of buffer hits for the table
Database NameName of the database the table is in
Dead Rows (Rows)Estimated number of dead rows
IDOID of the table
Index Scans (Scans)Number of index scans initiated on this table
Last Analyze by Auto DaemonLast time at which this table was analyzed by the autovacuum daemon
Last Manual AnalyzeLast time at which this table was manually analyzed
Last Manual VacuumLast time at which this table was manually vacuumed (not counting VACUUM FULL)
Last Vacuum by Auto DaemonLast time at which this table was vacuumed by the autovacuum daemon
Live Rows (Rows)Estimated number of live rows
Manual AnalyzesNumber of times this table has been manually analyzed
Manual VacuumsNumber of times this table has been manually vacuumed (not counting VACUUM FULL)
NameName of the Table
Rows Deleted (Rows)Number of rows deleted
Rows Fetched by Index Scans (Rows)Number of live rows fetched by index scans
Rows fetched by Sequential Scans (Rows)Number of live rows fetched by sequential scans
Rows Hot Updated (Rows)Number of rows HOT updated (i.e., with no separate index update required)
Rows Inserted (Rows)Number of rows inserted
Rows Modified Since Last Analyzed (Rows)Estimated number of rows modified since this table was last analyzed
Rows Updated (Rows)Number of rows updated
Schema NameName of the schema the table is in
Sequential Scans (Scans)Number of sequential scans initiated on this table
Size (Bytes)Disk space used by the table
Tablespace NameName of tablespace containing table (null if default for database)
Vacuums By Auto DaemonNumber of times this table has been vacuumed by the autovacuum daemon

Tablespace

NameDescription
LocationLocation (directory path) of the tablespace
NameName of the tablespace
OwnerOwner of the tablespace, usually the user who created it
Size (Bytes)Size of the tablespace on disk
Users with Create PrivilegesList of users who have CREATE privilege on this tablespace

Trigger

NameDescription
Enabled StatusControls in which session_replication_role modes the trigger fires. O = trigger fires in "origin" and "local" modes, D = trigger is disabled, R = trigger fires in "replica" mode, A = trigger fires always.
Fire TypeBit mask identifying trigger firing conditions
Function IDOID of the function to be called
IDOID of the trigger
NameTrigger name (must be unique among triggers of same table)
Passed ArgumentsArguments Passed to Trigger
Table IDOID of the table that the trigger is on
Table NameName of the table that the trigger is on

Updated 6 months ago

All Metrics


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.