2.3. Postgres - Server

Overview

Table 2.26. Overview

Description:PostgreSQL Server
Singleton: no
Plugin:Postgres

Child Resource Types

Autodiscovery Process Scans

Table 2.27. Metrics

NameQuery
unixprocess|basename|match=^(postgres|postmaster)$,process|basename|nomatch|parent=^(postgres|postmaster)$
windowsprocess|basename|match=^(?i)(postgres|postmaster)\.exe$,process|basename|nomatch|parent=^(?i)(postgres|postmaster)\.exe$

Connection Properties

Table 2.28. 

NameDescriptionRequiredInternal Name
listen hostthe hostname or IP address that the database is listening on yes host
listen portthe TCP port that the database is listening on yes port
database namethe name of the database to connect to yes db
JDBC driver classthe fully-qualified classname of the JDBC driver class no driverClass
role namethe database role to connect as yes principal
role passwordthe password for the database role being used to connect yes credentials
PGDATA directorythe absolute path to the directory containing the cluster configuration files postgresql.conf, pg_hba.conf, and pg_ident.conf yes pgdataDir
configuration filethe absolute path to the main cluster configuration file; default value is '{pgDataDir}/postgresql.conf', where [pgDataDir] is the value of the pgDataDir connection property no configFile

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.

Metrics

Table 2.29. Metrics

NameTypeDescriptionInternal Name
User TimemeasurementThe aggregate amount of CPU user time spent by all postgres processesProcess.aggregateCpu.user
User Time per MinutemeasurementThe aggregate amount of CPU user time spent by all postgres processesProcess.aggregateCpu.user
Kernel TimemeasurementThe aggregate amount of CPU kernel time spent by all postgres processesProcess.aggregateCpu.sys
Kernel Time per MinutemeasurementThe aggregate amount of CPU kernel time spent by all postgres processesProcess.aggregateCpu.sys
CPU PercentagemeasurementThe percentage of CPU currently being used by all postgres processesProcess.aggregateCpu.percent
Physical MemorymeasurementThe aggregate amount of resident memory used by all postgres processesProcess.aggregateMemory.resident
Virtual MemorymeasurementThe aggregate amount of virtual memory used by all postgres processesProcess.aggregateMemory.size
Open File DescriptorsmeasurementThe aggregate number of file descriptors open by all postgres processesProcess.aggregateFileDescriptor.total
Active BackendsmeasurementNumber of currently active backends (user connections)Database.backends
Start timetraitStart time of the PostgreSQL database serverDatabase.startTime

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.

Configuration Properties

Table 2.30. 

NameDescriptionRequiredInternal Name
PortSets the TCP port the server listens on; default value is '5432'. no port
Max_connectionsSets the maximum number of concurrent connections; default value is '100'. no max_connections
Shared_buffersSets the number of the shared memory buffers used by the server; default value is typically '1000'. no shared_buffers
Max_fsm_pagesMaximum FSM Pages, must be a minimum of max_fsm_relations*16, 6 bytes each) no max_fsm_pages
Log_destinationAvailable options depend on operating system; default value is 'stderr' no log_destination
Redirect_stderrEnable capturing of stderr into log files; enabled by default no redirect_stderr
Stats_start_collectorneeded for block or row stats; enabled by default no stats_start_collector
Stats_block_levelEnables the collection of block-level statistics on database activity; if this option is enabled, the data that is produced can be accessed via the pg_stat and pg_statio family of system views; disabled by default no stats_block_level
Stats_row_levelEnables the collection of row-level statistics on database activity; if this option is enabled, the data that is produced can be accessed via the pg_stat and pg_statio family of system views; disabled by default no stats_row_level
AutovacuumEnable autovacuum subprocess? (requires stats_start_collector and stats_row_level to also be on); enabled by default no autovacuum
Runtime Settingsproperties available from show all no runtimeSettings

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.

Operations

Table 2.31. Metrics

NameDescription
List Process StatisticsList statistics about the currently executing postgres backends

Package Types

none

2.3.1. Postgres - Database Service

Overview

Table 2.32. Overview

Description: 
Singleton: no
Plugin:Postgres

Child Resource Types

Connection Properties

Table 2.33. 

NameDescriptionRequiredInternal Name
Database Name  yes databaseName

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.

Metrics

Table 2.34. Metrics

NameTypeDescriptionInternal Name
BackendsmeasurementNumber of active server processes for databasenumbackends
Transactions CommittedmeasurementTransactions committed in databasexact_commit
Transactions Committed per MinutemeasurementTransactions committed in databasexact_commit
Transactions Rolled BackmeasurementTransactions rolled back in databasexact_rollback
Transactions Rolled Back per MinutemeasurementTransactions rolled back in databasexact_rollback
Blocks ReadmeasurementNumber of disk block fetch requests for databaseblks_read
Blocks Read per MinutemeasurementNumber of disk block fetch requests for databaseblks_read
Blocks HitmeasurementNumber of disk block fetch requests found in cache for database blks_hit
Blocks Hit per MinutemeasurementNumber of disk block fetch requests found in cache for database blks_hit
SizemeasurementDisk space used by the databasesize

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.

Configuration Properties

none

Operations

Table 2.35. Metrics

NameDescription
Reset StatisticsResets the statistics in this database
Invoke SqlExecute arbitrary SQL

Package Types

none

2.3.1.1. Postgres - Table Service

Overview

Table 2.36. Overview

Description:Database table
Singleton: no
Plugin:Postgres
Child Resource Types
none
Connection Properties

Table 2.37. 

NameDescriptionRequiredInternal Name
Table Name  yes tableName

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics

Table 2.38. Metrics

NameTypeDescriptionInternal Name
Sequential ScansmeasurementNumber of sequential scans done against this table (when an index scan was not possible)seq_scan
Sequential Scans per MinutemeasurementNumber of sequential scans done against this table (when an index scan was not possible)seq_scan
Sequential Rows ReadmeasurementNumber of rows read by sequential scansseq_tup_read
Sequential Rows Read per MinutemeasurementNumber of rows read by sequential scansseq_tup_read
Index ScansmeasurementNumber of index scans done against this tableidx_scan
Index Scans per MinutemeasurementNumber of index scans done against this tableidx_scan
Index Scan Rows ReadmeasurementNumber of index entries returned by index scansidx_tup_fetch
Index Scan Rows Read per MinutemeasurementNumber of index entries returned by index scansidx_tup_fetch
Heap Blocks ReadmeasurementThe number of heap blocks read that were not a buffer cache hitheap_blks_read
Heap Blocks Read per MinutemeasurementThe number of heap blocks read that were not a buffer cache hitheap_blks_read
Heap Blocks HitmeasurementThe number of heap block requests that were found in the buffer cacheheap_blks_hit
Heap Blocks Hit per MinutemeasurementThe number of heap block requests that were found in the buffer cacheheap_blks_hit
Index Blocks ReadmeasurementThe number of index blocks fetched that were not a buffer cache hitidx_blks_read
Index Blocks Read per MinutemeasurementThe number of index blocks fetched that were not a buffer cache hitidx_blks_read
Index Blocks HitmeasurementThe number of index block requests that were found in the buffer cacheidx_blks_hit
Index Blocks Hit per MinutemeasurementThe number of index block requests that were found in the buffer cacheidx_blks_hit
Toast Blocks ReadsmeasurementThe number of toast blocks fetched that were not a buffer cache hittoast_blks_read
Toast Blocks Reads per MinutemeasurementThe number of toast blocks fetched that were not a buffer cache hittoast_blks_read
Toast Blocks HitmeasurementThe number of toast block requests that were found in the buffer cachetoast_blks_hit
Toast Blocks Hit per MinutemeasurementThe number of toast block requests that were found in the buffer cachetoast_blks_hit
Toast Index Blocks ReadmeasurementThe number of toast index blocks fetched that were not a buffer cache hittidx_blks_read
Toast Index Blocks Read per MinutemeasurementThe number of toast index blocks fetched that were not a buffer cache hittidx_blks_read
Toast Index Blocks HitmeasurementThe number of toast index block requests that were found in the buffer cachetidx_blks_hit
Toast Index Blocks Hit per MinutemeasurementThe number of toast index block requests that were found in the buffer cachetidx_blks_hit
Row InsertsmeasurementThe number of rows ever inserted into this tablen_tup_ins
Row Inserts per MinutemeasurementThe number of rows ever inserted into this tablen_tup_ins
Row UpdatesmeasurementThe number of rows ever updated on this tablen_tup_upd
Row Updates per MinutemeasurementThe number of rows ever updated on this tablen_tup_upd
Row DeletesmeasurementThe number of rows ever deleted from this tablen_tup_del
Row Deletes per MinutemeasurementThe number of rows ever deleted from this tablen_tup_del
Table SizemeasurementThe size in bytes of the data in the tabletable_size
Total SizemeasurementThe size in bytes of the data and all associated indexes and toast tablestotal_size
RowsmeasurementThe count of rows in the table. Warning: This may be an expensive operationrows
Approximate rowsmeasurementThe approximate count of rows in the table. This is basically the number of rows of the last ANALYZE of the table. This metric is not expensive.rows_approx

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties

Table 2.39. 

NameDescriptionRequiredInternal Name
Table Name  yes tableName
Columns  yes columns

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Operations

Table 2.40. Metrics

NameDescription
VacuumVacuum the table
Package Types
none

2.3.1.2. Postgres - Query Service

Overview

Table 2.41. Overview

Description: 
Singleton: no
Plugin:Postgres
Child Resource Types
none
Connection Properties

Table 2.42. 

NameDescriptionRequiredInternal Name
TableThe table to discover and to be queried on for metric data yes table
NameInitial name of the resource when manually added. This is also part of the resource key - make this unique if you want two Query resources based on the same table. no name
DescriptionInitial description of resource when manually added no description
Metric QueryThe query that will gather metric data. This must return two columns, a string column whose value is 'metricColumn' and then a numeric column whose value is the metric to be collected. no metricQuery

Note

You must use the internal name to reference Configuration Properties in Dynamic Group Definition expressions.
Metrics

Table 2.43. Metrics

NameTypeDescriptionInternal Name
Metric ValuemeasurementThe metric value for this Query. If Metric Query is not specified, this is not collected.metricColumn

Note

You must use the internal name to reference Traits in Dynamic Group Definition expressions.
Configuration Properties
none
Operations
none
Package Types
none