PostgreSQL moduleedit

This module periodically fetches metrics from PostgreSQL servers.

Default metricsets are activity, bgwriter and database.


The PostgreSQL module comes with a predefined dashboard showing databse related metrics. For example:

metricbeat postgresql overview

Module-specific configuration notesedit

When configuring the hosts option, you must use Postgres URLs of the following format:


The URL can be as simple as:

- module: postgresql
  hosts: ["postgres://localhost"]

Or more complex like:

- module: postgresql
  hosts: ["postgres://localhost:40001?sslmode=disable", "postgres://otherhost:40001"]

You can also separately specify the username and password using the respective configuration options. Usernames and passwords specified in the URL take precedence over those specified in the username and password config options.

- module: postgresql
  metricsets: ["status"]
  hosts: ["postgres://localhost:5432"]
  username: root
  password: test


This module was tested with PostgreSQL 9, 10, 11, 12 and 13. It is expected to work with all versions >= 9.

Example configuration

The PostgreSQL module supports the standard configuration options that are described in Modules. Here is an example configuration:

- module: postgresql
  enabled: true
    # Stats about every PostgreSQL database
    - database

    # Stats about the background writer process's activity
    - bgwriter

    # Stats about every PostgreSQL process
    - activity

    # Stats about every statement executed in the server. It requires the
    # `pg_stats_statement` library to be configured in the server.
    #- statement

  period: 10s

  # The host must be passed as PostgreSQL URL. Example:
  # postgres://localhost:5432?sslmode=disable
  # The available parameters are documented here:
  hosts: ["postgres://localhost:5432"]

  # Username to use when connecting to PostgreSQL. Empty by default.
  #username: user

  # Password to use when connecting to PostgreSQL. Empty by default.
  #password: pass


The following metricsets are available: