PostgreSQL Receiver

OpenTelemetry Collector receiver · contrib distribution

This receiver queries the PostgreSQL statistics collector.

Component ID: contrib-postgresqlreceiver
Name: postgresqlreceiver
Type: receiver
Distribution: contrib
Repository: opentelemetry-collector-contrib

Stability

Level	Signals
beta	metrics
development	logs

Metrics

Metric	Type	Value type	Unit	Stability	Enabled	Attributes	Description
`postgresql.backends`	sum	int	1	development	yes	`db.namespace` (string)	The number of backend processes associated with each database. Counts backends across all connection states (active, idle, idle-in-transaction) and all backend types, including non-client backends such as autovacuum and parallel workers.
`postgresql.bgwriter.buffers.allocated`	sum (monotonic)	int	{buffers}	development	yes		Number of buffers allocated.
`postgresql.bgwriter.buffers.writes`	sum (monotonic)	int	{buffers}	development	yes	`bg_buffer_source` (string)	Number of buffers written.
`postgresql.bgwriter.checkpoint.count`	sum (monotonic)	int	{checkpoints}	development	yes	`bg_checkpoint_type` (string)	The number of checkpoints performed.
`postgresql.bgwriter.duration`	sum (monotonic)	double	ms	development	yes	`bg_duration_type` (string)	Total time spent writing and syncing files to disk by checkpoints.
`postgresql.bgwriter.maxwritten`	sum (monotonic)	int	1	development	yes		Number of times the background writer stopped a cleaning scan because it had written too many buffers.
`postgresql.blks_hit`	sum (monotonic)	int	{blks_hit}	development	no	`db.namespace` (string)	Number of times disk blocks were found already in the buffer cache.
`postgresql.blks_read`	sum (monotonic)	int	{blks_read}	development	no	`db.namespace` (string)	Number of disk blocks read in this database.
`postgresql.blocks_read`	sum (monotonic)	int	1	development	yes	`db.collection.name` (string), `db.namespace` (string), `source` (string)	The number of blocks read.
`postgresql.commits`	sum (monotonic)	int	1	development	yes	`db.namespace` (string)	The number of commits.
`postgresql.connection.max`	gauge	int	{connections}	development	yes		Configured maximum number of client connections allowed
`postgresql.database.count`	sum	int	{databases}	development	yes		Number of user databases.
`postgresql.database.locks`	gauge	int	{lock}	development	no	`db.namespace` (string), `lock_type` (string), `mode` (string), `relation` (string)	The number of database locks.
`postgresql.db_size`	sum	int	By	development	yes	`db.namespace` (string)	The database disk usage.
`postgresql.deadlocks`	sum (monotonic)	int	{deadlock}	development	no	`db.namespace` (string)	The number of deadlocks.
`postgresql.function.calls`	sum (monotonic)	int	{call}	development	no	`db.namespace` (string), `function` (string)	The number of calls made to a function. Requires `track_functions=pl\|all` in Postgres config.
`postgresql.index.scans`	sum (monotonic)	int	{scans}	development	yes	`db.collection.name` (string), `db.namespace` (string), `postgresql.index.name` (string)	The number of index scans on a table.
`postgresql.index.size`	gauge	int	By	development	yes	`db.collection.name` (string), `db.namespace` (string), `postgresql.index.name` (string)	The size of the index on disk.
`postgresql.operations`	sum (monotonic)	int	1	development	yes	`db.collection.name` (string), `db.namespace` (string), `operation` (string)	The number of db row operations.
`postgresql.query.conflicts`	sum (monotonic)	int	{query}	development	no	`db.namespace` (string), `postgresql.conflict.type` (string)	Number of queries canceled due to conflicts with recovery on this database. Conflicts only occur on standby servers; this metric will be zero on primary servers.
`postgresql.query.execution.time`	sum (monotonic)	double	s	development	no	`db.namespace` (string)	The total execution time of SQL statements currently tracked by pg_stat_statements for the database.
`postgresql.replication.data_delay`	gauge	int	By	development	yes	`replication_client` (string)	The amount of data delayed in replication.
`postgresql.rollbacks`	sum (monotonic)	int	1	development	yes	`db.namespace` (string)	The number of rollbacks.
`postgresql.rows`	sum	int	1	development	yes	`db.collection.name` (string), `db.namespace` (string), `state` (string)	The number of rows in the database.
`postgresql.sequential_scans`	sum (monotonic)	int	{sequential_scan}	development	no	`db.collection.name` (string), `db.namespace` (string)	The number of sequential scans.
`postgresql.table.count`	sum	int	{table}	development	yes	`db.namespace` (string)	Number of user tables in a database.
`postgresql.table.size`	sum	int	By	development	yes	`db.collection.name` (string), `db.namespace` (string)	Disk space used by a table.
`postgresql.table.vacuum.count`	sum (monotonic)	int	{vacuum}	development	yes	`db.collection.name` (string), `db.namespace` (string)	Number of times a table has manually been vacuumed.
`postgresql.temp.io`	sum (monotonic)	int	By	development	no	`db.namespace` (string)	Total amount of data written to temporary files by queries.
`postgresql.temp_files`	sum (monotonic)	int	{temp_file}	development	no	`db.namespace` (string)	The number of temp files.
`postgresql.tup_deleted`	sum (monotonic)	int	{tup_deleted}	development	no	`db.namespace` (string)	Number of rows deleted by queries in the database.
`postgresql.tup_fetched`	sum (monotonic)	int	{tup_fetched}	development	no	`db.namespace` (string)	Number of rows fetched by queries in the database.
`postgresql.tup_inserted`	sum (monotonic)	int	{tup_inserted}	development	no	`db.namespace` (string)	Number of rows inserted by queries in the database.
`postgresql.tup_returned`	sum (monotonic)	int	{tup_returned}	development	no	`db.namespace` (string)	Number of rows returned by queries in the database.
`postgresql.tup_updated`	sum (monotonic)	int	{tup_updated}	development	no	`db.namespace` (string)	Number of rows updated by queries in the database.
`postgresql.vector.insert.duration`	sum (monotonic)	double	s	development	no	`db.namespace` (string)	The cumulative execution time of statements that insert vectors into pgvector tables. Requires the `pg_stat_statements` extension, PostgreSQL 13 or later, and the `pgvector` extension in the scanned database.
`postgresql.vector.insert.rows`	sum (monotonic)	int	{vectors}	development	no	`db.namespace` (string)	The number of vectors inserted into pgvector tables. Requires the `pg_stat_statements` extension, PostgreSQL 13 or later, and the `pgvector` extension in the scanned database.
`postgresql.vector.search.calls`	sum (monotonic)	int	{search}	development	no	`db.namespace` (string), `postgresql.distance.function.name` (string)	The number of vector similarity search operations executed, grouped by the distance function used. Requires the `pg_stat_statements` extension, PostgreSQL 13 or later, and the `pgvector` extension in the scanned database. The `l1`, `hamming`, and `jaccard` distance functions additionally require pgvector 0.7.0 or later.
`postgresql.vector.search.duration`	sum (monotonic)	double	s	development	no	`db.namespace` (string), `postgresql.distance.function.name` (string)	The cumulative execution time of vector similarity searches, grouped by the distance function used. Requires the `pg_stat_statements` extension, PostgreSQL 13 or later, and the `pgvector` extension in the scanned database. The `l1`, `hamming`, and `jaccard` distance functions additionally require pgvector 0.7.0 or later.
`postgresql.vector.search.rows_returned`	sum (monotonic)	int	{rows}	development	no	`db.namespace` (string), `postgresql.distance.function.name` (string)	The cumulative number of rows returned by vector similarity searches, grouped by the distance function used. Requires the `pg_stat_statements` extension, PostgreSQL 13 or later, and the `pgvector` extension in the scanned database. The `l1`, `hamming`, and `jaccard` distance functions additionally require pgvector 0.7.0 or later.
`postgresql.wal.age`	gauge	int	s	development	yes		Age of the oldest WAL file. This metric requires WAL to be enabled with at least one replica.
`postgresql.wal.delay`	gauge	double	s	development	no	`replication_client` (string), `wal_operation_lag` (string)	Time between flushing recent WAL locally and receiving notification that the standby server has completed an operation with it. This metric requires WAL to be enabled with at least one replica.
`postgresql.wal.lag`	gauge	int	s	development	yes	`replication_client` (string), `wal_operation_lag` (string)	Time between flushing recent WAL locally and receiving notification that the standby server has completed an operation with it. This metric requires WAL to be enabled with at least one replica.

Attributes

Attribute	Type	Description
`bg_buffer_source`	string	The source of a buffer write.
`bg_checkpoint_type`	string	The type of checkpoint state.
`bg_duration_type`	string	The type of time spent during the checkpoint.
`db.collection.name`	string	The name of the table within the database.
`db.namespace`	string	The database namespace, following the `{database}\|{schema}` format defined by OpenTelemetry semantic conventions for PostgreSQL.
`db.query.text`	string	The text of the database query being executed.
`db.system.name`	string	The database management system (DBMS) product as identified by the client instrumentation.
`function`	string	The name of the function.
`lock_type`	string	Type of the lockable object.
`mode`	string	Name of the lock mode held or desired by the process.
`network.peer.address`	string	IP address of the client connected to this backend.
`network.peer.port`	int	TCP port number that the client is using for communication with this backend.
`operation`	string	The database operation.
`postgresql.application_name`	string	Name of the application that is connected to this backend.
`postgresql.blocking.lock.mode`	string	The lock mode being requested by the blocked session (e.g. RowExclusiveLock, AccessExclusiveLock). Empty string when not blocked.
`postgresql.blocking.lock.relation`	string	The name of the relation (table) being waited on. Empty string when not blocked or when lock is not on a relation.
`postgresql.blocking.lock.type`	string	The type of lock resource being waited on (e.g. relation, transactionid, tuple). Empty string when not blocked.
`postgresql.blocking.pids`	string	Array of PIDs of sessions blocking this session (from pg_blocking_pids). Empty array when not blocked.
`postgresql.blocking.start_time`	string	UTC timestamp (RFC3339) when the current lock wait began, derived from pg_locks.waitstart. Empty string when not blocked.
`postgresql.blocking.transaction.start_time`	string	UTC timestamp (RFC3339) when the current transaction started. Empty string when no active transaction.
`postgresql.blocking.wait_duration`	int	Whole seconds this session has been waiting for a lock, measured from pg_locks.waitstart. 0 when not blocked.
`postgresql.calls`	int	Number of times the statement was executed, reported in delta value.
`postgresql.client_hostname`	string	Host name of the connected client, as reported by a reverse DNS lookup of client_addr.
`postgresql.conflict.type`	string	The type of recovery conflict that caused a query to be canceled on a standby server.
`postgresql.distance.function.name`	string	The vector distance (similarity) function used by the query, one of the pgvector distance functions.
`postgresql.index.name`	string	The name of the index on a table.
`postgresql.pid`	int	Process ID of this backend.
`postgresql.query_id`	string	Identifier of this backend's most recent query. If state is active this field shows the identifier of the currently executing query. In all other states, it shows the identifier of last query that was executed.
`postgresql.query_plan`	string	The execution plan used by PostgreSQL for the query.
`postgresql.query_start`	string	Time when the currently active query was started, or if state is not active, when the last query was started.
`postgresql.queryid`	string	Hash code to identify identical normalized queries.
`postgresql.rolname`	string	The name of the PostgreSQL role that executed the query.
`postgresql.rows`	int	Total number of rows retrieved or affected by the statement, reported in delta value.
`postgresql.shared_blks_dirtied`	int	Total number of shared blocks dirtied by the statement, reported in delta value.
`postgresql.shared_blks_hit`	int	Total number of shared block cache hits by the statement, reported in delta value.
`postgresql.shared_blks_read`	int	Total number of shared blocks read by the statement, reported in delta value.
`postgresql.shared_blks_written`	int	Total number of shared blocks written by the statement, reported in delta value.
`postgresql.state`	string	Current overall state of this backend
`postgresql.temp_blks_read`	int	Total number of temp blocks read by the statement, reported in delta value.
`postgresql.temp_blks_written`	int	Total number of temp blocks written by the statement, reported in delta value.
`postgresql.total_exec_time`	double	Total time spent executing the statement, in delta seconds.
`postgresql.total_plan_time`	double	Total time spent planning the statement, in delta seconds.
`postgresql.wait_event`	string	Wait event name if backend is currently waiting, otherwise NULL.
`postgresql.wait_event_type`	string	The type of event for which the backend is waiting, if any; otherwise NULL.
`relation`	string	OID of the relation targeted by the lock, or null if the target is not a relation or part of a relation.
`replication_client`	string	The IP address of the client connected to this backend. If this field is "unix", it indicates either that the client is connected via a Unix socket.
`source`	string	The block read source type.
`state`	string	The tuple (row) state.
`user.name`	string	Name of the user logged into this backend.
`wal_operation_lag`	string	The operation which is responsible for the lag.

Data

JSON (latest): /data/collector/components/contrib-postgresqlreceiver/latest.json
JSON (pinned): /data/collector/components/contrib-postgresqlreceiver/contrib-postgresqlreceiver-579e14ab1d7a.json
Explore: /collector/components/contrib/postgresqlreceiver