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
| 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
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 |
| Add Missing From | trait | Automatically adds missing table references to FROM clauses | Runtime.add_missing_from |
| Allow System Table Mods | trait | Allows modifications of the structure of system tables | Runtime.allow_system_table_mods |
| Archive Command | trait | WAL archiving command | Runtime.archive_command |
| Archive Timeout | trait | Forces a switch to the next xlog file if a new file has not been started within the specified amount of time | Runtime.archive_timeout |
| Array Nulls | trait | Enable input of NULL elements in arrays. | Runtime.array_nulls |
| Authentication Timeout | trait | The maximum allowed time to complete client authentication | Runtime.authentication_timeout |
| Autovacuum | trait | Starts the autovacuum subprocess. | Runtime.autovacuum |
| Autovacuum Analyze Scale Factor | trait | Number of tuple inserts, updates or deletes prior to analyze as a fraction of reltuples. | Runtime.autovacuum_analyze_scale_factor |
| Autovacuum Analyze Threshold | trait | Minimum number of tuple inserts, updates or deletes prior to analyze. | Runtime.autovacuum_analyze_threshold |
| Autovacuum Freeze Max Age | trait | Age (in transactions) at which to autovacuum a table to prevent transaction ID wraparound. | Runtime.autovacuum_freeze_max_age |
| Autovacuum Naptime | trait | Amount of time to sleep between autovacuum runs | Runtime.autovacuum_naptime |
| Autovacuum Vacuum Cost Delay | trait | Vacuum cost delay for autovacuum | Runtime.autovacuum_vacuum_cost_delay |
| Autovacuum Vacuum Cost Limit | trait | Vacuum cost amount available before napping, for autovacuum. | Runtime.autovacuum_vacuum_cost_limit |
| Autovacuum Vacuum Scale Factor | trait | Number of tuple updates or deletes prior to vacuum as a fraction of reltuples. | Runtime.autovacuum_vacuum_scale_factor |
| Autovacuum Vacuum Threshold | trait | Minimum number of tuple updates or deletes prior to vacuum. | Runtime.autovacuum_vacuum_threshold |
| Backslash Quote | trait | Whether quotes are allowed in string literals | Runtime.backslash_quote |
| Bgwriter All Maxpages | trait | Background writer maximum number of all pages to flush per round | Runtime.bgwriter_all_maxpages |
| Bgwriter All Percent | trait | Background writer percentage of all buffers to flush per round | Runtime.bgwriter_all_percent |
| Bgwriter Delay | trait | Background writer sleep time between rounds; default unit is milliseconds | Runtime.bgwriter_delay |
| Bgwriter Lru Maxpages | trait | Background writer maximum number of LRU pages to flush per round | Runtime.bgwriter_lru_maxpages |
| Bgwriter Lru Percent | trait | Background writer percentage of LRU buffers to flush per round | Runtime.bgwriter_lru_percent |
| Block Size | trait | Shows size of a disk block; determined by the value of BLCKSZ when building the server; default unit is bytes | Runtime.block_size |
| Bonjour Name | trait | The Bonjour broadcast service name | Runtime.bonjour_name |
| Check Function Bodies | trait | Check function bodies during CREATE FUNCTION. | Runtime.check_function_bodies |
| Checkpoint Segments | trait | The maximum distance (in log segments) between automatic WAL checkpoints. | Runtime.checkpoint_segments |
| Checkpoint Timeout | trait | The maximum amount of time between automatic WAL checkpoints; default unit is seconds | Runtime.checkpoint_timeout |
| Checkpoint Warning | trait | Logs if filling of checkpoint segments happens more frequently than this amount of time; default unit is seconds | Runtime.checkpoint_warning |
| Client Encoding | trait | The client's character set encoding. | Runtime.client_encoding |
| Client Min Messages | trait | The message levels that are sent to the client. | Runtime.client_min_messages |
| Commit Delay | trait | The delay in between transaction commit and flushing WAL to disk; default unit is microseconds | Runtime.commit_delay |
| Commit Siblings | trait | The minimum concurrent open transactions before performing commit_delay. | Runtime.commit_siblings |
| Config File | trait | The server's main configuration file. | Runtime.config_file |
| Constraint Exclusion | trait | Enables the planner to use constraints to optimize queries. | Runtime.constraint_exclusion |
| Cpu Index Tuple Cost | trait | The planner's estimate of the cost of processing each index entry during an index scan; measured on the same scale as the seq_page_cost configuration parameter | Runtime.cpu_index_tuple_cost |
| Cpu Operator Cost | trait | The planner's estimate of the cost of processing each operator or function call; measured on the same scale as the seq_page_cost configuration parameter | Runtime.cpu_operator_cost |
| Cpu Tuple Cost | trait | The planner's estimate of the cost of processing each tuple (row); measured on the same scale as the seq_page_cost configuration parameter | Runtime.cpu_tuple_cost |
| Custom Variable Classes | trait | The list of known custom variable classes | Runtime.custom_variable_classes |
| Data Directory | trait | The server's data directory. | Runtime.data_directory |
| DateStyle | trait | The display format for date and time values. | Runtime.DateStyle |
| Db User Namespace | trait | Enables per-database user names. | Runtime.db_user_namespace |
| Deadlock Timeout | trait | The amount of time to wait on lock before checking for a deadlock; default unit is milliseconds | Runtime.deadlock_timeout |
| Debug Assertions | trait | Turns on various assertion checks. | Runtime.debug_assertions |
| Debug Pretty Print | trait | Indents parse and plan tree displays. | Runtime.debug_pretty_print |
| Debug Print Parse | trait | Prints the parse tree to the server log. | Runtime.debug_print_parse |
| Debug Print Plan | trait | Prints the execution plan to server log. | Runtime.debug_print_plan |
| Debug Print Rewritten | trait | Prints the parse tree after rewriting to server log. | Runtime.debug_print_rewritten |
| Default Statistics Target | trait | The default statistics target; range 1-1000. | Runtime.default_statistics_target |
| Default Tablespace | trait | The default tablespace to create tables and indexes in. | Runtime.default_tablespace |
| Default Transaction Isolation | trait | The transaction isolation level of each new transaction. | Runtime.default_transaction_isolation |
| Default Transaction Read Only | trait | The default read-only status of new transactions. | Runtime.default_transaction_read_only |
| Default With Oids | trait | Create new tables with OIDs by default. | Runtime.default_with_oids |
| Dynamic Library Path | trait | The path for dynamically loadable modules. | Runtime.dynamic_library_path |
| Effective Cache Size | trait | The planner's assumption about size of the disk cache; the unit is disk pages, which are normally 8KB each | Runtime.effective_cache_size |
| Enable Bitmapscan | trait | Enables the planner's use of bitmap-scan plans. | Runtime.enable_bitmapscan |
| Enable Hashagg | trait | Enables the planner's use of hashed aggregation plans. | Runtime.enable_hashagg |
| Enable Hashjoin | trait | Enables the planner's use of hash join plans. | Runtime.enable_hashjoin |
| Enable Indexscan | trait | Enables the planner's use of index-scan plans. | Runtime.enable_indexscan |
| Enable Mergejoin | trait | Enables the planner's use of merge join plans. | Runtime.enable_mergejoin |
| Enable Nestloop | trait | Enables the planner's use of nested-loop join plans. | Runtime.enable_nestloop |
| Enable Seqscan | trait | Enables the planner's use of sequential-scan plans. | Runtime.enable_seqscan |
| Enable Sort | trait | Enables the planner's use of explicit sort steps. | Runtime.enable_sort |
| Enable Tidscan | trait | Enables the planner's use of TID scan plans. | Runtime.enable_tidscan |
| Escape String Warning | trait | Warn about backslash escapes in ordinary string literals. | Runtime.escape_string_warning |
| Explain Pretty Print | trait | Uses the indented output format for EXPLAIN VERBOSE. | Runtime.explain_pretty_print |
| External Pid File | trait | Writes the postmaster PID to the specified file. | Runtime.external_pid_file |
| Extra Float Digits | trait | The number of extra digits displayed for floating-point values. | Runtime.extra_float_digits |
| From Collapse Limit | trait | The FROM-list size beyond which subqueries are not collapsed | Runtime.from_collapse_limit |
| Fsync | trait | Forces synchronization of updates to disk. | Runtime.fsync |
| Full Page Writes | trait | Writes full pages to WAL when first modified after a checkpoint. | Runtime.full_page_writes |
| Geqo | trait | Enables genetic query optimization | Runtime.geqo |
| Geqo Effort | trait | GEQO: effort is used to set the default for other GEQO parameters; range 1-10 | Runtime.geqo_effort |
| Geqo Generations | trait | GEQO: number of iterations of the algorithm; default selected based on effort. | Runtime.geqo_generations |
| Geqo Pool Size | trait | GEQO: number of individuals in the population; default selected based on effort. | Runtime.geqo_pool_size |
| Geqo Selection Bias | trait | GEQO: selective pressure within the population. | Runtime.geqo_selection_bias |
| Geqo Threshold | trait | The threshold of FROM items beyond which GEQO is used. | Runtime.geqo_threshold |
| Gin Fuzzy Search Limit | trait | The maximum allowed result for exact search by GIN. | Runtime.gin_fuzzy_search_limit |
| Hba File | trait | The server's hba [configuration file] | Runtime.hba_file |
| Ident File | trait | The server's ident [configuration file] | Runtime.ident_file |
| Ignore System Indexes | trait | Disables reading from system indexes. | Runtime.ignore_system_indexes |
| Integer Datetimes | trait | Datetimes are integer based. | Runtime.integer_datetimes |
| Join Collapse Limit | trait | The FROM-list size beyond which JOIN constructs are not flattened | Runtime.join_collapse_limit |
| Krb Caseins Users | trait | Whether Kerberos user names should be treated as case-insensitive. | Runtime.krb_caseins_users |
| Krb Server Hostname | trait | The hostname of the Kerberos server. | Runtime.krb_server_hostname |
| Krb Server Keyfile | trait | The location of the Kerberos server key file. | Runtime.krb_server_keyfile |
| Krb Srvname | trait | The name of the Kerberos service. | Runtime.krb_srvname |
| Lc Collate | trait | Shows the collation order locale. | Runtime.lc_collate |
| Lc Ctype | trait | Shows the character classification and case conversion locale. | Runtime.lc_ctype |
| Lc Messages | trait | The language in which messages are displayed. | Runtime.lc_messages |
| Lc Monetary | trait | The locale for formatting monetary amounts. | Runtime.lc_monetary |
| Lc Numeric | trait | The locale for formatting numbers. | Runtime.lc_numeric |
| Lc Time | trait | The locale for formatting date and time values. | Runtime.lc_time |
| Listen Addresses | trait | The host name or IP address(es) to listen to. | Runtime.listen_addresses |
| Local Preload Libraries | trait | Lists shared libraries to preload into each backend. | Runtime.local_preload_libraries |
| Log Connections | trait | Logs each successful connection. | Runtime.log_connections |
| Log Destination | trait | The destination for server log output. | Runtime.log_destination |
| Log Directory | trait | The destination directory for log files. | Runtime.log_directory |
| Log Disconnections | trait | Logs end of a session, including duration. | Runtime.log_disconnections |
| Log Duration | trait | Logs the duration of each completed SQL statement. | Runtime.log_duration |
| Log Error Verbosity | trait | The verbosity of logged messages. | Runtime.log_error_verbosity |
| Log Executor Stats | trait | Writes executor performance statistics to the server log. | Runtime.log_executor_stats |
| Log Filename | trait | The file name pattern for log files. | Runtime.log_filename |
| Log Hostname | trait | Logs the host name in the connection logs. | Runtime.log_hostname |
| Log Line Prefix | trait | Controls information prefixed to each log line | Runtime.log_line_prefix |
| Log Min Duration Statement | trait | The minimum execution time (in milliseconds) above which statements will be logged. | Runtime.log_min_duration_statement |
| Log Min Error Statement | trait | Causes all statements generating error at or above this level to be logged. | Runtime.log_min_error_statement |
| Log Min Messages | trait | The message levels that are logged. | Runtime.log_min_messages |
| Log Parser Stats | trait | Writes parser performance statistics to the server log. | Runtime.log_parser_stats |
| Log Planner Stats | trait | Writes planner performance statistics to the server log. | Runtime.log_planner_stats |
| Log Rotation Age | trait | Automatic log file rotation will occur after this amount of time; default unit is minutes | Runtime.log_rotation_age |
| Log Rotation Size | trait | Automatic log file rotation will occur when the file reaches this size; default unit is kilobytes | Runtime.log_rotation_size |
| Log Statement | trait | The type of statements logged. | Runtime.log_statement |
| Log Statement Stats | trait | Writes cumulative performance statistics to the server log. | Runtime.log_statement_stats |
| Log Truncate On Rotation | trait | Truncate existing log files of same name during log rotation. | Runtime.log_truncate_on_rotation |
| Maintenance Work Mem | trait | The maximum memory to be used for maintenance operations. | Runtime.maintenance_work_mem |
| Max Connections | trait | The maximum number of concurrent connections. | Runtime.max_connections |
| Max Files Per Process | trait | The maximum number of simultaneously open files for each server process. | Runtime.max_files_per_process |
| Max Fsm Pages | trait | The maximum number of disk pages for which free space is tracked. | Runtime.max_fsm_pages |
| Max Fsm Relations | trait | The maximum number of tables and indexes for which free space is tracked. | Runtime.max_fsm_relations |
| Max Function Args | trait | Shows the maximum number of function arguments. | Runtime.max_function_args |
| Max Identifier Length | trait | Shows the maximum identifier length | Runtime.max_identifier_length |
| Max Index Keys | trait | Shows the maximum number of index keys. | Runtime.max_index_keys |
| Max Locks Per Transaction | trait | The maximum number of locks per transaction. | Runtime.max_locks_per_transaction |
| Max Prepared Transactions | trait | The maximum number of simultaneously prepared transactions. | Runtime.max_prepared_transactions |
| Max Stack Depth | trait | The maximum size of the server's execution stack; default unit is kilobytes | Runtime.max_stack_depth |
| Password Encryption | trait | Encrypt passwords. | Runtime.password_encryption |
| Port | trait | The TCP port the server listens on | Runtime.port |
| Post Auth Delay | trait | Waits the specified amount of time on connection startup after authentication; default unit is seconds | Runtime.post_auth_delay |
| Pre Auth Delay | trait | Waits the specified amount of time on connection startup before authentication; default unit is seconds | Runtime.pre_auth_delay |
| Random Page Cost | trait | The planner's estimate of the cost of a nonsequentially fetched disk page; measured on the same scale as the seq_page_cost configuration parameter | Runtime.random_page_cost |
| Redirect Stderr | trait | Start a subprocess to capture stderr output into log files | Runtime.redirect_stderr |
| Regex Flavor | trait | The regular expression flavor. | Runtime.regex_flavor |
| Search Path | trait | The schema search order for names that are not schema-qualified. | Runtime.search_path |
| Seq Page Cost | trait | The planner's estimate of the cost of a sequentially fetched disk page; measured on an arbitrary scale. | Runtime.seq_page_cost |
| Server Encoding | trait | The server (database) character set encoding. | Runtime.server_encoding |
| Server Version | trait | Shows the PostgreSQL version. | Runtime.server_version |
| Server Version Num | trait | Shows the PostgreSQL version as an integer (e.g. 80204 translates to 8.2.4). | Runtime.server_version_num |
| Shared Buffers | trait | The amount of memory for the shared memory buffers used by the server | Runtime.shared_buffers |
| Shared Preload Libraries | trait | Lists shared libraries to preload into server. | Runtime.shared_preload_libraries |
| Silent Mode | trait | Runs the server silently. | Runtime.silent_mode |
| Sql Inheritance | trait | Causes subtables to be included by default in various commands. | Runtime.sql_inheritance |
| Ssl | trait | Enables SSL connections. | Runtime.ssl |
| Standard Conforming Strings | trait | '...' strings treat backslashes literally. | Runtime.standard_conforming_strings |
| Statement Timeout | trait | The maximum allowed duration of any statement; default unit is milliseconds | Runtime.statement_timeout |
| Stats Block Level | trait | Collects block-level statistics on database activity. | Runtime.stats_block_level |
| Stats Command String | trait | Collects information about executing commands. | Runtime.stats_command_string |
| Stats Reset On Server Start | trait | Zeroes collected statistics on server restart. | Runtime.stats_reset_on_server_start |
| Stats Row Level | trait | Collects row-level statistics on database activity. | Runtime.stats_row_level |
| Stats Start Collector | trait | Starts the server statistics-collection subprocess. | Runtime.stats_start_collector |
| Superuser Reserved Connections | trait | The number of connection slots reserved for superusers | Runtime.superuser_reserved_connections |
| Tcp Keepalives Count | trait | Maximum number of TCP keepalive retransmits; '0' selects the system default | Runtime.tcp_keepalives_count |
| Tcp Keepalives Idle | trait | Amount of time between issuing TCP keepalives; '0' selects the system default; default unit is seconds | Runtime.tcp_keepalives_idle |
| Tcp Keepalives Interval | trait | Amount of time between TCP keepalive retransmits; '0' selects the system default; default unit is seconds | Runtime.tcp_keepalives_interval |
| Temp Buffers | trait | The maximum number of temporary buffers used by each session. | Runtime.temp_buffers |
| TimeZone | trait | The time zone for displaying and interpreting time stamps. | Runtime.TimeZone |
| Timezone Abbreviations | trait | Selects a file of time zone abbreviations | Runtime.timezone_abbreviations |
| Trace Notify | trait | Generates debugging output for LISTEN and NOTIFY. | Runtime.trace_notify |
| Trace Sort | trait | Emit information about resource usage in sorting. | Runtime.trace_sort |
| Transaction Isolation | trait | The current transaction's isolation level. | Runtime.transaction_isolation |
| Transaction Read Only | trait | The current transaction's read-only status. | Runtime.transaction_read_only |
| Transform Null Equals | trait | Treats expr=NULL as expr IS NULL | Runtime.transform_null_equals |
| Unix Socket Directory | trait | The directory where the Unix-domain socket will be created | Runtime.unix_socket_directory |
| Unix Socket Group | trait | The owning group of the Unix-domain socket | Runtime.unix_socket_group |
| Unix Socket Permissions | trait | The access permissions of the Unix-domain socket | Runtime.unix_socket_permissions |
| Update Process Title | trait | Updates the process title to show the active SQL command. | Runtime.update_process_title |
| Vacuum Cost Delay | trait | Vacuum cost delay; default unit is milliseconds; range 0-1000 | Runtime.vacuum_cost_delay |
| Vacuum Cost Limit | trait | Vacuum cost (in credits) amount available before napping. | Runtime.vacuum_cost_limit |
| Vacuum Cost Page Dirty | trait | Vacuum cost (in credits) for a page dirtied by vacuum; range 0-10000 | Runtime.vacuum_cost_page_dirty |
| Vacuum Cost Page Hit | trait | Vacuum cost (in credits) for a page found in the buffer cache; range 0-10000 | Runtime.vacuum_cost_page_hit |
| Vacuum Cost Page Miss | trait | Vacuum cost (in credits) for a page not found in the buffer cache; range 0-10000 | Runtime.vacuum_cost_page_miss |
| Vacuum Freeze Min Age | trait | Minimum age (in transactions) at which VACUUM should freeze a table row. | Runtime.vacuum_freeze_min_age |
| Wal Buffers | trait | The number of disk-page buffers in shared memory for WAL | Runtime.wal_buffers |
| Wal Sync Method | trait | Selects the method used for forcing WAL updates out to disk. | Runtime.wal_sync_method |
| Work Mem | trait | The maximum memory to be used for query workspaces; default unit is kilobytes | Runtime.work_mem |
| Zero Damaged Pages | trait | Continues processing past damaged page headers. | Runtime.zero_damaged_pages |
Note
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 |
Note
Operations
Table 2.31. Metrics
| Name | Description |
|---|---|
| List Process Statistics | List statistics about the currently executing postgres backends. state column result is only available with Postgres 9.2+ |
Package Types
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
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
Configuration Properties
Operations
Table 2.35. Metrics
| Name | Description |
|---|---|
| Reset Statistics | Resets the statistics in this database |
| Invoke Sql | Execute arbitrary SQL |
| Remove orphan large objects | Removes orphaned large objects from pg_largeobject |
Package Types
2.3.1.1. Postgres - Table Service
Overview
Table 2.36. Overview
| Description: | Database table |
| Singleton: | no |
| Plugin: | Postgres |
Child Resource Types
Connection Properties
Table 2.37.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Schema Name | yes | schemaName | |
| Table Name | yes | tableName |
Note
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
Configuration Properties
Table 2.39.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Schema Name | yes | schemaName | |
| Table Name | yes | tableName | |
| Columns | yes | columns |
Note
Operations
Table 2.40. Metrics
| Name | Description |
|---|---|
| Vacuum | Vacuum the table |
Package Types
2.3.1.2. Postgres - Query Service
Overview
Table 2.41. Overview
| Description: | |
| Singleton: | no |
| Plugin: | Postgres |
Child Resource Types
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
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
Configuration Properties
Operations
Package Types
2.3.2. Postgres - User Service
Overview
Table 2.44. Overview
| Description: | A User in the Postgres System |
| Singleton: | no |
| Plugin: | Postgres |
Child Resource Types
Connection Properties
Metrics
Table 2.45. Metrics
| Name | Type | Description | Internal Name |
|---|---|---|---|
| Total User Connections | measurement | The total number of user connections in the system, whether actively querying or idle | total |
| Active User Connections | measurement | The number of user connections in the system actively querying | active |
Note
Configuration Properties
Table 2.46.
| Name | Description | Required | Internal Name |
|---|---|---|---|
| Inherit Rights | Inherit rights from parent roles. | yes | inheritRights |
| Super User | Is a super user. | yes | superuser |
| Can Create Database Types | Implied for a super user. | yes | canCreateDatabaseObjects |
| Can Create Roles | Implied for a super user. | yes | canCreateRoles |
| Can Update System Catalogs Directly | Even a superuser cannot update system catalogs unless this property is true. False is implied for a non super user. | yes | canModifyCatalogDirectly |
| User connection limit | yes | connectionLimit | |
| User | yes | user | |
| Can Login | yes | canLogin | |
| Password | yes | password |
Note

Where did the comment section go?
Red Hat's documentation publication system recently went through an upgrade to enable speedier, more mobile-friendly content. We decided to re-evaluate our commenting platform to ensure that it meets your expectations and serves as an optimal feedback mechanism. During this redesign, we invite your input on providing feedback on Red Hat documentation via the discussion platform.