Red Hat Training

A Red Hat training course is available for Red Hat JBoss Operations Network

2.3. Postgres - Server (Deprecated)

Important

This plug-in is deprecated in JBoss ON 3.1.2 and will be removed in a future release.

Overview

Table 2.26. Overview

Description: PostgreSQL Server
Singleton: no
Plugin: Postgres

Child Resource Types

Autodiscovery Process Scans

Table 2.27. Metrics

Name Query
unix process|basename|match=^(postgres|postmaster)$,process|basename|nomatch|parent=^(postgres|postmaster)$
windows process|basename|match=^(?i)(postgres|postmaster)\.exe$,process|basename|nomatch|parent=^(?i)(postgres|postmaster)\.exe$

Connection Properties

Table 2.28. 

Name Description Required Internal Name
listen host the hostname or IP address that the database is listening on yes host
listen port the TCP port that the database is listening on yes port
database name the name of the database to connect to yes db
JDBC driver class the fully-qualified classname of the JDBC driver class no driverClass
role name the database role to connect as yes principal
role password the password for the database role being used to connect yes credentials
PGDATA directory the absolute path to the directory containing the cluster configuration files postgresql.conf, pg_hba.conf, and pg_ident.conf yes pgdataDir
configuration file the 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

Name Type Description Internal Name
User Time measurement The aggregate amount of CPU user time spent by all postgres processes Process.aggregateCpu.user
User Time per Minute measurement The aggregate amount of CPU user time spent by all postgres processes Process.aggregateCpu.user
Kernel Time measurement The aggregate amount of CPU kernel time spent by all postgres processes Process.aggregateCpu.sys
Kernel Time per Minute measurement The aggregate amount of CPU kernel time spent by all postgres processes Process.aggregateCpu.sys
CPU Percentage measurement The percentage of CPU currently being used by all postgres processes Process.aggregateCpu.percent
Physical Memory measurement The aggregate amount of resident memory used by all postgres processes Process.aggregateMemory.resident
Virtual Memory measurement The aggregate amount of virtual memory used by all postgres processes Process.aggregateMemory.size
Open File Descriptors measurement The aggregate number of file descriptors open by all postgres processes Process.aggregateFileDescriptor.total
Active Backends measurement Number of currently active backends (user connections) Database.backends
Start time trait Start time of the PostgreSQL database server Database.startTime

Note

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

Configuration Properties

Table 2.30. 

Name Description Required Internal Name
Port Sets the TCP port the server listens on; default value is '5432'. no port
Max_connections Sets the maximum number of concurrent connections; default value is '100'. no max_connections
Shared_buffers Sets the number of the shared memory buffers used by the server; default value is typically '1000'. no shared_buffers
Max_fsm_pages Maximum FSM Pages, must be a minimum of max_fsm_relations*16, 6 bytes each) no max_fsm_pages
Log_destination Available options depend on operating system; default value is 'stderr' no log_destination
Redirect_stderr Enable capturing of stderr into log files; enabled by default no redirect_stderr
Stats_start_collector needed for block or row stats; enabled by default no stats_start_collector
Stats_block_level Enables 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_level Enables 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
Autovacuum Enable autovacuum subprocess? (requires stats_start_collector and stats_row_level to also be on); enabled by default no autovacuum
Runtime Settings properties 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

Name Description
List Process Statistics List 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. 

Name Description Required Internal 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

Name Type Description Internal Name
Backends measurement Number of active server processes for database numbackends
Transactions Committed measurement Transactions committed in database xact_commit
Transactions Committed per Minute measurement Transactions committed in database xact_commit
Transactions Rolled Back measurement Transactions rolled back in database xact_rollback
Transactions Rolled Back per Minute measurement Transactions rolled back in database xact_rollback
Blocks Read measurement Number of disk block fetch requests for database blks_read
Blocks Read per Minute measurement Number of disk block fetch requests for database blks_read
Blocks Hit measurement Number of disk block fetch requests found in cache for database blks_hit
Blocks Hit per Minute measurement Number of disk block fetch requests found in cache for database blks_hit
Size measurement Disk space used by the database size

Note

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

Configuration Properties

none

Operations

Table 2.35. Metrics

Name Description
Reset Statistics Resets the statistics in this database
Invoke Sql Execute 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. 

Name Description Required Internal 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

Name Type Description Internal Name
Sequential Scans measurement Number of sequential scans done against this table (when an index scan was not possible) seq_scan
Sequential Scans per Minute measurement Number of sequential scans done against this table (when an index scan was not possible) seq_scan
Sequential Rows Read measurement Number of rows read by sequential scans seq_tup_read
Sequential Rows Read per Minute measurement Number of rows read by sequential scans seq_tup_read
Index Scans measurement Number of index scans done against this table idx_scan
Index Scans per Minute measurement Number of index scans done against this table idx_scan
Index Scan Rows Read measurement Number of index entries returned by index scans idx_tup_fetch
Index Scan Rows Read per Minute measurement Number of index entries returned by index scans idx_tup_fetch
Heap Blocks Read measurement The number of heap blocks read that were not a buffer cache hit heap_blks_read
Heap Blocks Read per Minute measurement The number of heap blocks read that were not a buffer cache hit heap_blks_read
Heap Blocks Hit measurement The number of heap block requests that were found in the buffer cache heap_blks_hit
Heap Blocks Hit per Minute measurement The number of heap block requests that were found in the buffer cache heap_blks_hit
Index Blocks Read measurement The number of index blocks fetched that were not a buffer cache hit idx_blks_read
Index Blocks Read per Minute measurement The number of index blocks fetched that were not a buffer cache hit idx_blks_read
Index Blocks Hit measurement The number of index block requests that were found in the buffer cache idx_blks_hit
Index Blocks Hit per Minute measurement The number of index block requests that were found in the buffer cache idx_blks_hit
Toast Blocks Reads measurement The number of toast blocks fetched that were not a buffer cache hit toast_blks_read
Toast Blocks Reads per Minute measurement The number of toast blocks fetched that were not a buffer cache hit toast_blks_read
Toast Blocks Hit measurement The number of toast block requests that were found in the buffer cache toast_blks_hit
Toast Blocks Hit per Minute measurement The number of toast block requests that were found in the buffer cache toast_blks_hit
Toast Index Blocks Read measurement The number of toast index blocks fetched that were not a buffer cache hit tidx_blks_read
Toast Index Blocks Read per Minute measurement The number of toast index blocks fetched that were not a buffer cache hit tidx_blks_read
Toast Index Blocks Hit measurement The number of toast index block requests that were found in the buffer cache tidx_blks_hit
Toast Index Blocks Hit per Minute measurement The number of toast index block requests that were found in the buffer cache tidx_blks_hit
Row Inserts measurement The number of rows ever inserted into this table n_tup_ins
Row Inserts per Minute measurement The number of rows ever inserted into this table n_tup_ins
Row Updates measurement The number of rows ever updated on this table n_tup_upd
Row Updates per Minute measurement The number of rows ever updated on this table n_tup_upd
Row Deletes measurement The number of rows ever deleted from this table n_tup_del
Row Deletes per Minute measurement The number of rows ever deleted from this table n_tup_del
Table Size measurement The size in bytes of the data in the table table_size
Total Size measurement The size in bytes of the data and all associated indexes and toast tables total_size
Rows measurement The count of rows in the table. Warning: This may be an expensive operation rows
Approximate rows measurement The 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. 

Name Description Required Internal 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

Name Description
Vacuum Vacuum 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. 

Name Description Required Internal Name
Table The table to discover and to be queried on for metric data yes table
Name Initial 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
Description Initial description of resource when manually added no description
Metric Query The 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

Name Type Description Internal Name
Metric Value measurement The 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