PostgreSQL exporter (postgres-exporter)

Exposes the metrics of the bound PostgreSQL server to Prometheus.

Generated from catalog/services/postgres-exporter.yaml: do not edit by hand.

Summary

Version	0.17.1
Use	install and configure
Layer	infrastructure (shown apart)
Category	Observability
Installation methods	binary
External connection	no
Sandbox only	no

Licence

SPDX identifier	Apache-2.0
Licence policy	core licence (MIT or Apache-2.0)
Licence exception	-
Platform component	postgres-exporter

Packages and artifacts

A package the project of the service publishes (its image, its binary archive, its Python or OS package) carries the licence of the service; a third-party package carries the licence written on its row, read from the official upstream metadata.

Kind	Package	Version	Licence	Details
binary archive	postgres_exporter-0.17.1.linux-amd64.tar.gz	0.17.1	Apache-2.0	https://github.com/prometheus-community/postgres_exporter/releases/download/v0.17.1/postgres_exporter-0.17.1.linux-amd64.tar.gz, x86_64, checksum sha256

Supported systems and architectures

Method	Operating systems	Architectures
binary	RHEL family (dnf), Debian family (apt), Arch Linux (pacman)	x86_64 (architecture of the artifacts of the descriptor)

Certified host systems: RHEL 8/9/10, Rocky Linux 8/9/10, AlmaLinux 8/9/10, Oracle Linux 8/9, CentOS Stream 9/10, Ubuntu 22.04/24.04, Debian 12, Arch Linux (rolling). The host preflight accepts these systems (other releases of a known family give a warning, end of life releases are refused) and the x86_64 and aarch64 architectures.

Prerequisites

Host

The descriptor declares no host preflight check.

Network and ports

Component	Port name	Port	Opened in the host firewall
postgres-exporter	metrics	9187/tcp	yes

Services and connections needed

• postgresql: postgresql.

Details and resolution: see Dependencies.

Installation methods and modes

Method	Default	What the method uses
binary	yes	the binary archives of the descriptor, unpacked under the service directory

Components

Component	Kind	Installation methods	Ports
PostgreSQL exporter (postgres-exporter)	worker	binary	9187/tcp

Single (single) (default)

One exporter for the bound server.

What the mode deploys:

Component	Placement
postgres-exporter	min 1, max 1

Install this service

The install wizard of the Navin Manager plans, validates and runs the installation; you need the services:install permission on the cluster.

1. Open the wizard. In Clusters, choose the row action Install services of the target cluster. The wizard opens on its first step, Service.

2. Choose the service. On the Service step, select PostgreSQL exporter. The card shows the licence Apache-2.0 and the dependencies the installation needs.

3. Choose the hosts and the mode. On the Hosts step, tick the hosts, then choose the Mode: single (default). Each mode deploys the components listed in Installation methods and modes.

4. Bind the dependencies. On the Bindings step, choose for each dependency (postgresql) Install with the platform or Use an existing connection; an optional dependency can stay on No binding.

5. Configure. On the Configure step, review the parameters (see Configuration parameters). Passwords left empty with a generated default are generated and sealed by the Manager.

6. Review and install. On the Install step the Manager validates the plan and shows the installation order; when it says "The plan is valid. Ready to install.", choose Install. A highly available mode is installed only when its HA checks pass.

7. Verify. The operation ends when the health checks of every instance pass (see Health checks); the service then shows as running in Services.

High availability

Cluster	none (none)
High availability	external (external)
Failover	none (none)
Replication	none (none)
Quorum	none (none)
Discovery	static (static)
Entry point	any node (any-node)
Official documentation	https://github.com/prometheus-community/postgres_exporter/blob/master/docs/README.md

Prerequisites

Prerequisite	Must be highly available	Modes	Description
postgresql	no	modes of level ha or cluster	Monitoring account on the watched server.

Topology per mode

Modes	Highest catalog level	Distribution	Quorum component	Fault domains	Description
single	standalone (standalone)	single (single)	-	1	One exporter for the bound server.

Notes

• The exporter follows the availability of the server it watches: one exporter per server (or multi-target); Prometheus alerts when it stops answering.

Configuration parameters

General

Parameter	Type	Default	Allowed values	Required	Secret	Restart	Description
Metrics port (port)	port	9187	-	no	no	no	Port of /metrics.
TLS (tls_enabled)	bool	false	-	no	no	no	Serve /metrics over HTTPS (--web.config.file) with a certificate issued by the manager CA; Prometheus then scrapes it in https and verifies it with that CA.

Dependencies

For each active dependency the Manager takes the first of: the binding chosen in the wizard; a service of the same installation that provides it; a service already installed in the cluster; the only connection of the expected type. Otherwise an optional dependency stays unbound, and a required one is added to the installation in its default mode (the column below names the catalog service added).

Binding	Provided by	Connection type	Endpoint	Optional	When nothing is bound	Description
postgresql	-	postgresql	-	no	postgresql is added to the installation	PostgreSQL server to observe (a monitoring role with pg_monitor).

Endpoints

Endpoint	Scheme	Component	Port	Path	TLS parameter	Binding parameters	Binding secrets	Provisioning command
metrics	http	postgres-exporter	9187 (port)	/metrics	tls_enabled	-	-	-

Health checks

Liveness (per instance)

Component	Check	Details
postgres-exporter	HTTP {{ 'https' if config.tls_enabled else 'http' }}://{{ host.fqdn if config.tls_enabled else (host.ip or '127.0.0.1') }}:{{ config.port }}/metrics	Expected 200; 20 retries; interval 1 s; timeout 5 s

Uninstall

Paths removed when the data is purged: {{ paths.log }}.

Upstream documentation

• Homepage: https://github.com/prometheus-community/postgres_exporter
• Source: https://github.com/prometheus-community/postgres_exporter
• High availability: https://github.com/prometheus-community/postgres_exporter/blob/master/docs/README.md