Getting started #

This Database Monitoring Framework is designed to work in Kubernetes and Prometheus operator environment, but it could be used in different environments.

Quick deployment #

Tips
Look at architecture page to understand the role of each component.
See also our tutorials for concrete deployment example.

Steps to deploy the framework on on your infrastructure:

Prometheus Kubernetes Operator

Requirements

Helm
Prometheus Kubernetes operator
1. ruleSelector must be enabled (documentation)
2. serviceMonitorSelector must be enabled for ServiceMonitor (documentation)

Steps

Deploy Prometheus RDS exporter and/or Prometheus PostgreSQL exporter

Deploy charts with helm

# RDS alerts
helm install prometheus-rds-alerts-chart oci://public.ecr.aws/qonto/prometheus-rds-alerts-chart \
--version 0.2.1 \
--namespace monitoring

# PostgreSQL alerts
helm install prometheus-postgresql-alerts-chart oci://public.ecr.aws/qonto/prometheus-postgresql-alerts-chart \
--version 0.2.1 \
--namespace monitoring

Connect to Prometheus to check that the rules are correctly loaded (https://<your_prometheus_url>/rules)

Prometheus standalone server

Requirements

Steps

Deploy Prometheus RDS exporter and/or Prometheus PostgreSQL exporter

Generate Prometheus rule configuration files

# Generate RDS rules in /etc/prometheus/rds.rules.yaml
helm template oci://public.ecr.aws/qonto/prometheus-rds-alerts-chart \
--version 0.2.1 \
--set format=PrometheusConfigurationFile \
> /etc/prometheus/rds.rules.yaml

# Generate PostgreSQL rules in /etc/prometheus/postgresql.rules.yaml
helm template oci://public.ecr.aws/qonto/prometheus-postgresql-alerts-chart \
--version 0.2.1 \
--set format=PrometheusConfigurationFile \
> /etc/postgresql.rules.yaml

Add files to the rule_files parameter in the Prometheus configuration file

rule_files:
  - /etc/prometheus/rds.rules.yaml
  - /etc/prometheus/postgresql.rules.yaml

Reload Prometheus configuration
Connect to Prometheus to check that the rules are correctly loaded (https://<your_prometheus_url>/rules)

Charts #

Prometheus alerts are available as Helm chart:

Component	Chart URL	Website	Parameters
RDS	oci://public.ecr.aws/qonto/prometheus-rds-alerts-chart	Link	Link
PostgreSQL	oci://public.ecr.aws/qonto/prometheus-postgresql-alerts-chart	Link	Link