OS Manuals

/usr/bin/postgres_exporter

Percona postgres_exporter as shipped by PMM

From percona-postgres-exporter 3.10.0-r1 (enterprise-packages), captured 2026-11-09 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.database  Enable the database collector (default: enabled).
      --[no-]collector.database_wraparound
                                 Enable the database_wraparound collector (default: enabled).
      --[no-]collector.extensions
                                 Enable the extensions collector (default: enabled).
      --[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_slot
                                 Enable the replication_slot collector (default: enabled).
      --[no-]collector.stat_activity_autovacuum
                                 Enable the stat_activity_autovacuum collector (default: disabled).
      --[no-]collector.stat_bgwriter
                                 Enable the stat_bgwriter collector (default: enabled).
      --[no-]collector.stat_database
                                 Enable the stat_database collector (default: enabled).
      --[no-]collector.stat_io   Enable the stat_io collector (default: disabled).
      --[no-]collector.stat_statements
                                 Enable the stat_statements collector (default: disabled).
      --[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: disabled).
      --config.file=""           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.config=""            [EXPERIMENTAL] Path to config yaml file that can enable TLS or
                                 authentication.
      --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-]disable-settings-metrics
                                 Do not include pg_settings metrics.
                                 ($PG_EXPORTER_DISABLE_SETTINGS_METRICS)
      --[no-]auto-discover-databases
                                 Whether to discover the databases on a server dynamically.
                                 (DEPRECATED) ($PG_EXPORTER_AUTO_DISCOVER_DATABASES)
      --[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)
      --[no-]collect.custom_query.lr
                                 Enable custom queries with low resolution directory.
                                 ($PG_EXPORTER_EXTEND_QUERY_LR)
      --[no-]collect.custom_query.mr
                                 Enable custom queries with medium resolution directory.
                                 ($PG_EXPORTER_EXTEND_QUERY_MR)
      --[no-]collect.custom_query.hr
                                 Enable custom queries with high resolution directory.
                                 ($PG_EXPORTER_EXTEND_QUERY_HR)
      --collect.custom_query.lr.directory=COLLECT.CUSTOM_QUERY.LR.DIRECTORY
                                 Path to custom queries with low resolution directory.
                                 ($PG_EXPORTER_EXTEND_QUERY_LR_PATH)
      --collect.custom_query.mr.directory=COLLECT.CUSTOM_QUERY.MR.DIRECTORY
                                 Path to custom queries with medium resolution directory.
                                 ($PG_EXPORTER_EXTEND_QUERY_MR_PATH)
      --collect.custom_query.hr.directory=COLLECT.CUSTOM_QUERY.HR.DIRECTORY
                                 Path to custom queries with high resolution directory.
                                 ($PG_EXPORTER_EXTEND_QUERY_HR_PATH)
      --max-connections=5        Maximum number of connections to use ($PG_EXPORTER_MAX_CONNECTIONS)
      --[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 (16)
OptionDescriptionSource
-hShow context-sensitive help (also try --help-long and --help-man).help
--config.file ""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.config ""[EXPERIMENTAL] Path to config yaml file that can enable TLS or authentication.help
--web.telemetry-path "/metrics"Path under which to expose metrics.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
--collect.custom_query.lr.directory COLLECT.CUSTOM_QUERY.LR.DIRECTORYPath to custom queries with low resolution directory.help
--collect.custom_query.mr.directory COLLECT.CUSTOM_QUERY.MR.DIRECTORYPath to custom queries with medium resolution directory.help
--collect.custom_query.hr.directory COLLECT.CUSTOM_QUERY.HR.DIRECTORYPath to custom queries with high resolution directory.help
--max-connections 5Maximum number of connections to use ($PG_EXPORTER_MAX_CONNECTIONS)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.