PostgreSQL server endpoint in libpq-style connection strings.

endpoints

A list of databases to match (by using [POSIX Regular Expressions](https://www.postgresql.org/docs/current/functions-matching.html#FUNCTIONS-POSIX-REGEXP)) against
the `datname` column for which you don't want to collect metrics from.
Specifying `""` will include metrics where `datname` is `NULL`.
This can be used in conjunction with [`include_databases`](#include_databases).

exclude_databases

A list of databases to match (by using [POSIX Regular Expressions](https://www.postgresql.org/docs/current/functions-matching.html#FUNCTIONS-POSIX-REGEXP)) against
the `datname` column for which you want to collect metrics from. If not set, metrics are collected from
all databases. Specifying `""` will include metrics where `datname` is `NULL`. This can be used in
conjunction with [`exclude_databases`](#exclude_databases).

include_databases

The namespace of metrics. Disabled if empty.

namespace

scrape_interval_secs

TLS options to connect to the PostgreSQL Server.

ca_file

The component type. This is a required field for all components and tells Vector which component to use.

type

[PostgreSQL](https://www.postgresql.org/) is a powerful, open source object-relational database system with over 30 years
of active development that has earned it a strong reputation for reliability, feature robustness, and
performance.

PostgreSQL Server

Enriches data with useful PostgreSQL Server context.

By default, the `postgresql_metrics` source augments events with helpful
context keys.

context

Context

PostgreSQL Metrics component collects metrics by making queries to the configured PostgreSQL server.
Ensure the configured user is allowed to make the select queries against the following views:

- `pg_stat_database`
- `pg_stat_database_conflicts`
- `pg_stat_bgwriter`

privileges

Required Privileges

This component is stateless, meaning its behavior is consistent across each input.

state

State

postgresql_metrics

pg_stat_bgwriter_buffers_alloc_total

Number of times a backend had to execute its own fsync call (normally the background writer handles those even when the backend does its own write).

pg_stat_bgwriter_buffers_backend_fsync_total

Number of buffers written directly by a backend.

pg_stat_bgwriter_buffers_backend_total

Number of buffers written during checkpoints.

pg_stat_bgwriter_buffers_checkpoint_total

Number of buffers written by the background writer.

pg_stat_bgwriter_buffers_clean_total

Total amount of time that has been spent in the portion of checkpoint processing where files are synchronized to disk.

pg_stat_bgwriter_checkpoint_sync_time_seconds_total

Total amount of time that has been spent in the portion of checkpoint processing where files are written to disk.

pg_stat_bgwriter_checkpoint_write_time_seconds_total

Number of requested checkpoints that have been performed.

pg_stat_bgwriter_checkpoints_req_total

Number of scheduled checkpoints that have been performed.

pg_stat_bgwriter_checkpoints_timed_total

Number of times the background writer stopped a cleaning scan because it had written too many buffers.

pg_stat_bgwriter_maxwritten_clean_total

Time at which these statistics were last reset.

pg_stat_bgwriter_stats_reset

Time spent reading data file blocks by backends in this database, in milliseconds (if `track_io_timing` is enabled, otherwise zero).

pg_stat_database_blk_read_time_seconds_total

Time spent writing data file blocks by backends in this database, in milliseconds (if `track_io_timing` is enabled, otherwise zero).

pg_stat_database_blk_write_time_seconds_total

Number of times disk blocks were found already in the buffer cache, so that a read was not necessary (this only includes hits in the PostgreSQL buffer cache, not the operating system's file system cache).

pg_stat_database_blks_hit_total

Number of disk blocks read in this database.

pg_stat_database_blks_read_total

Number of data page checksum failures detected in this database (or on a shared object), or 0 if data checksums are not enabled.

pg_stat_database_checksum_failures_total

Time at which the last data page checksum failure was detected in this database (or on a shared object), or 0 if data checksums are not enabled.

pg_stat_database_checksum_last_failure

Number of queries in this database that have been canceled due to pinned buffers.

pg_stat_database_conflicts_confl_bufferpin_total

Number of queries in this database that have been canceled due to deadlocks.

pg_stat_database_conflicts_confl_deadlock_total

Number of queries in this database that have been canceled due to lock timeouts.

pg_stat_database_conflicts_confl_lock_total

Number of queries in this database that have been canceled due to old snapshots.

pg_stat_database_conflicts_confl_snapshot_total

Number of queries in this database that have been canceled due to dropped tablespaces.

pg_stat_database_conflicts_confl_tablespace_total

Number of queries canceled due to conflicts with recovery in this database. (Conflicts occur only on standby servers; see `pg_stat_database_conflicts` for details.)

pg_stat_database_conflicts_total

OID of this database, or 0 for objects belonging to a shared relation.

pg_stat_database_datid

Number of deadlocks detected in this database.

pg_stat_database_deadlocks_total

Number of backends currently connected to this database, or 0 for shared objects. This is the only column in this view that returns a value reflecting current state; all other columns return the accumulated values since the last reset.

pg_stat_database_numbackends

pg_stat_database_stats_reset

Total amount of data written to temporary files by queries in this database. All temporary files are counted, regardless of why the temporary file was created, and regardless of the `log_temp_files` setting.

pg_stat_database_temp_bytes_total

Number of temporary files created by queries in this database. All temporary files are counted, regardless of why the temporary file was created (e.g., sorting or hashing), and regardless of the `log_temp_files` setting.

pg_stat_database_temp_files_total

Number of rows deleted by queries in this database.

pg_stat_database_tup_deleted_total

Number of rows fetched by queries in this database.

pg_stat_database_tup_fetched_total

Number of rows inserted by queries in this database.

pg_stat_database_tup_inserted_total

Number of rows returned by queries in this database.

pg_stat_database_tup_returned_total

Number of rows updated by queries in this database.

pg_stat_database_tup_updated_total

Number of transactions in this database that have been committed.

pg_stat_database_xact_commit_total

Number of transactions in this database that have been rolled back.

pg_stat_database_xact_rollback_total

Whether the PostgreSQL server is up or not.

The total number of metrics collections completed for this component.

collect_completed_total

The duration spent collecting of metrics for this component.

collect_duration_seconds

The number of events accepted by this component either from tagged
origin like file and uri, or cumulatively from other origins.

events_in_total

The total number of events emitted by this component.

events_out_total

The total number of requests errors for this component.

request_errors_total

A ratio from 0 to 1 of the load on a component. A value of 0 would indicate a completely idle component that is simply waiting for input. A value of 1 would indicate a that is never idle. This value is updated every 5 seconds.

PostgreSQL Metrics

Configuration Options

Required Options

endpoints(required)

type(required)

Advanced Options

scrape_interval_secs(optional)

namespace(optional)

include_databases(optional)

exclude_databases(optional)

tls(optional)

How it Works

Required Privileges

State

Context