Setting up Prometheus

Prometheus can be set up on any Linux-based system, but pgMonitor currently only supports running it on RHEL/CentOS 7 or later.

• Installation
  • RHEL / CentOS
• Upgrading
• Setup
  • RHEL / CentOS

Installation

RHEL / CentOS

With RPM Packages

There are RPM packages available to Crunchy Data customers through the Crunchy Customer Portal. To access the pgMonitor packages, please follow the same instructions for setting up access to the Crunchy Postgres packages.

After installing via these RPMs, you can continue reading at the Setup section.

Available Packages

Without Crunchy Data Packages

For installations without using packages provided by Crunchy Data, we recommend using the repository maintained at https://github.com/lest/prometheus-rpm. Instructions for setup and installation are contained there. Note this only sets up the base service. The additional files and steps for pgMonitor still need to be set up as instructed below.

Or you can also download Prometheus and Alertmanager from the original site at https://prometheus.io/download. Note that no base service setup is provided here, just the binaries.

Minimum Versions

pgMonitor has been tested with the following versions at a minimum. Later versions should generally work. If they do not, please open an issue on our Github.

• Prometheus 2.49.1
• Alertmanager 0.26.0

User and Configuration Directory Installation

You will need to create a system user named ccp_monitoring which you can do with the following command:

sudo useradd -m -d /var/lib/ccp_monitoring ccp_monitoring

Configuration File Installation

The files contained in this repository are assumed to be installed in the following locations with the following names:

Prometheus

The Prometheus data directory should be /var/lib/ccp_monitoring/prometheus and owned by the ccp_monitoring user. You can set it up with:

sudo install -d -m 0700 -u ccp_monitoring -g ccp_monitoring /var/lib/ccp_monitoring/prometheus

The following pgmonitor configuration files should be placed according to the following mapping:

Alertmanager

The Alertmanager data directory should be /var/lib/ccp_monitoring/alertmanager and owned by the ccp_monitoring user. You can set it up with:

sudo install -d -m 0700 -o ccp_monitoring -g ccp_monitoring /var/lib/ccp_monitoring/alertmanager

The following pgMonitor configuration files should be placed according to the following mapping:

Upgrading

• If you are upgrading to version 5.0 and transitioning to using the new sql_exporter, please see the documentation in Upgrading to pgMonitor v5.0.0
• See the CHANGELOG for full details on both major & minor version upgrades.
• Note, items like the alert rules and configuration files often require user edits. The packages will install newer versions of these files, but if the user has changed their contents but kept the same file name, the package will not overwrite them. Instead it will make a file with an *.rpmnew extension that contains the newer version of the file. These new files can be reviewed/compared to he user’s file to incorporate any desired changes.

Setup

Setup on RHEL/CentOS

Service Configuration

The following files contain defaults that should enable Prometheus and Alertmanager to run effectively on your system for the purposes of using pgmonitor. You should take some time to review them.

If you need to modify them, see the notes in the files for more details and recommendations:

• /etc/systemd/system/prometheus.service.d/crunchy-prometheus-service-rhel.conf
• /etc/systemd/system/alertmanager.service.d/crunchy-alertmanager-service-rhel.conf

The below files contain startup properties for Prometheues and Alertmanager. Please review and modify these files as you see fit:

• /etc/sysconfig/prometheus
• /etc/sysconfig/alertmanager

The below files dictate how Prometheus and Alertmanager will behave at runtime for the purposes of using pgMonitor. Please review each file below and follow the instructions in order to set things up:

Blackbox Exporter

By default, the Blackbox exporter probes are commented out in the crunchy-prometheus.yml file; please see the notes in that commented out section. For the default IPv4 TCP port targets that pgMonitor configures the blackbox_exporter with, the desired monitoring targets can be configured under the static_configs: targets section of the blackbox_tcp_services job; some examples for Grafana & Patroni are given there. It is also possible to create another auto-scrape target directory similar to auto.d and manage your blackbox targets more dynamically.

If you configure additional probes beyond the one that pgMonitor comes with, you will need to create a different Prometheus job_name for them for the given params: module name.

An example rules file for monitoring Blackbox probes, crunchy-alert-rules-blackbox.yml.example , is available in the alert-rules.d folder.

Enable Services

To enable and start Prometheus as a service, execute the following commands:

sudo systemctl enable prometheus
sudo systemctl start prometheus
sudo systemctl status prometheus

To enable and start Alertmanager as a service, execute the following commands:

sudo systemctl enable alertmanager
sudo systemctl start alertmanager
sudo systemctl status alertmanager