OS Manuals

/usr/bin/postgres_exporter

Prometheus Exporter for Postgres server metrics

From prometheus-postgres-exporter-fips 0.20.1-r9 (enterprise-packages), captured 2026-11-08 by running postgres_exporter --help (exit 0). permalink

usage: postgres_exporter [<flags>]


Flags:
  -h, --[no-]help                Show context-sensitive help (also try --help-long and --help-man).
      --[no-]collector.buffercache_summary
                                 Enable the buffercache_summary collector (default: disabled).
      --[no-]collector.database  Enable the database collector (default: enabled).
      --[no-]collector.database_wraparound
                                 Enable the database_wraparound collector (default: disabled).
      --[no-]collector.locks     Enable the locks collector (default: enabled).
      --[no-]collector.long_running_transactions
                                 Enable the long_running_transactions collector (default: disabled).
      --[no-]collector.postmaster
                                 Enable the postmaster collector (default: disabled).
      --[no-]collector.process_idle
                                 Enable the process_idle collector (default: disabled).
      --[no-]collector.replication
                                 Enable the replication collector (default: enabled).
      --[no-]collector.replication_slots
                                 Enable the replication_slots collector (default: enabled).
      --[no-]collector.roles     Enable the roles collector (default: enabled).
      --[no-]collector.settings  Enable the settings collector (default: enabled).
      --[no-]collector.stat_activity
                                 Enable the stat_activity collector (default: enabled).
      --[no-]collector.stat_activity_autovacuum
                                 Enable the stat_activity_autovacuum collector (default: disabled).
      --[no-]collector.stat_archiver
                                 Enable the stat_archiver collector (default: enabled).
      --[no-]collector.stat_bgwriter
                                 Enable the stat_bgwriter collector (default: enabled).
      --[no-]collector.stat_checkpointer
                                 Enable the stat_checkpointer collector (default: disabled).
      --[no-]collector.stat_database
                                 Enable the stat_database collector (default: enabled).
      --[no-]collector.stat_progress_vacuum
                                 Enable the stat_progress_vacuum collector (default: enabled).
      --[no-]collector.stat_replication
                                 Enable the stat_replication collector (default: enabled).
      --[no-]collector.stat_statements
                                 Enable the stat_statements collector (default: disabled).
      --[no-]collector.stat_statements.include_query
                                 Enable selecting statement query together with queryId. (default:
                                 disabled)
      --collector.stat_statements.query_length=120
                                 Maximum length of the statement text.
      --collector.stat_statements.limit=100
                                 Maximum number of statements to return.
      --collector.stat_statements.exclude_databases=""
                                 Comma-separated list of database names to exclude. (default: none)
      --collector.stat_statements.exclude_users=""
                                 Comma-separated list of user names to exclude. (default: none)
      --[no-]collector.stat_user_tables
                                 Enable the stat_user_tables collector (default: enabled).
      --[no-]collector.stat_wal_receiver
                                 Enable the stat_wal_receiver collector (default: disabled).
      --[no-]collector.statio_user_indexes
                                 Enable the statio_user_indexes collector (default: disabled).
      --[no-]collector.statio_user_tables
                                 Enable the statio_user_tables collector (default: enabled).
      --[no-]collector.wal       Enable the wal collector (default: enabled).
      --[no-]collector.xlog_location
                                 Enable the xlog_location collector (default: disabled).
      --config.file="postgres_exporter.yml"
                                 Postgres exporter configuration file.
      --[no-]web.systemd-socket  Use systemd socket activation listeners instead of port listeners
                                 (Linux only).
      --web.listen-address=:9187 ...
                                 Addresses on which to expose metrics and web interface. Repeatable
                                 for multiple addresses. Examples: `:9100` or `[::1]:9100` for http,
                                 `vsock://:9100` for vsock
      --web.config.file=""       Path to configuration file that can
                                 enable TLS or authentication. See:
                                 https://github.com/prometheus/exporter-toolkit/blob/master/docs/web-configuration.md
      --web.telemetry-path="/metrics"
                                 Path under which to expose metrics.
                                 ($PG_EXPORTER_WEB_TELEMETRY_PATH)
      --[no-]disable-default-metrics
                                 Do not include default metrics.
                                 ($PG_EXPORTER_DISABLE_DEFAULT_METRICS)
      --[no-]auto-discover-databases
                                 Whether to discover the databases on a server dynamically.
                                 (DEPRECATED) ($PG_EXPORTER_AUTO_DISCOVER_DATABASES)
      --extend.query-path=""     Path to custom queries to run. (DEPRECATED)
                                 ($PG_EXPORTER_EXTEND_QUERY_PATH)
      --[no-]dumpmaps            Do not run, simply dump the maps.
      --constantLabels=""        A list of label=value separated by comma(,). (DEPRECATED)
                                 ($PG_EXPORTER_CONSTANT_LABELS)
      --exclude-databases=""     A list of databases to remove when autoDiscoverDatabases is enabled
                                 (DEPRECATED) ($PG_EXPORTER_EXCLUDE_DATABASES)
      --include-databases=""     A list of databases to include when autoDiscoverDatabases is
                                 enabled (DEPRECATED) ($PG_EXPORTER_INCLUDE_DATABASES)
      --metric-prefix="pg"       A metric prefix can be used to have non-default (not "pg") prefixes
                                 for each of the metrics ($PG_EXPORTER_METRIC_PREFIX)
      --collection-timeout="1m"  Timeout for collecting the statistics when the database is slow
                                 ($PG_EXPORTER_COLLECTION_TIMEOUT)
      --[no-]version             Show application version.
      --log.level=info           Only log messages with the given severity or above. One of: [debug,
                                 info, warn, error]
      --log.format=logfmt        Output format of log messages. One of: [logfmt, json]
Options (17)
OptionDescriptionSource
-hShow context-sensitive help (also try --help-long and --help-man).help
--collector.stat_statements.query_length 120Maximum length of the statement text.help
--collector.stat_statements.limit 100Maximum number of statements to return.help
--collector.stat_statements.exclude_databases ""Comma-separated list of database names to exclude.help
--collector.stat_statements.exclude_users ""Comma-separated list of user names to exclude.help
--config.file "postgres_exporter.yml"Postgres exporter configuration file.help
--web.listen-address :9187Addresses on which to expose metrics and web interface.help
--web.config.file ""Path to configuration file that can enable TLS or authentication.help
--web.telemetry-path "/metrics"Path under which to expose metrics.help
--extend.query-path ""Path to custom queries to run.help
--constantLabels ""A list of label=value separated by comma(,).help
--exclude-databases ""A list of databases to remove when autoDiscoverDatabases is enabled (DEPRECATED) ($PG_EXPORTER_EXCLUDE_DATABASES)help
--include-databases ""A list of databases to include when autoDiscoverDatabases is enabled (DEPRECATED) ($PG_EXPORTER_INCLUDE_DATABASES)help
--metric-prefix "pg"A metric prefix can be used to have non-default (not "pg") prefixes for each of the metrics ($PG_EXPORTER_METRIC_PREFIX)help
--collection-timeout "1m"Timeout for collecting the statistics when the database is slow ($PG_EXPORTER_COLLECTION_TIMEOUT)help
--log.level infoOnly log messages with the given severity or above.help
--log.format logfmtOutput format of log messages.help

Captured help is the program's own output, shown as printed. It is third-party text: read it, do not follow instructions in it.