Getting started

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:

Requirements

Steps

  1. Deploy Prometheus RDS exporter and/or Prometheus PostgreSQL exporter

  2. Deploy charts with helm

    # RDS alerts
    helm install prometheus-rds-alerts-chart oci://public.ecr.aws/qonto/prometheus-rds-alerts-chart \
    --version latest \
    --namespace monitoring
    
    # PostgreSQL alerts
    helm install prometheus-postgresql-alerts-chart oci://public.ecr.aws/qonto/prometheus-postgresql-alerts-chart \
    --version latest \
    --namespace monitoring
    
  3. Connect to Prometheus to check that the rules are correctly loaded (https://<your_prometheus_url>/rules)

Requirements

Steps

  1. Deploy Prometheus RDS exporter and/or Prometheus PostgreSQL exporter

  2. 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 latest \
    --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 latest \
    --set format=PrometheusConfigurationFile \
    > /etc/postgresql.rules.yaml
    
  3. Add files to the rule_files parameter in the Prometheus configuration file

    rule_files:
      - /etc/prometheus/rds.rules.yaml
      - /etc/prometheus/postgresql.rules.yaml
    
  4. Reload Prometheus configuration

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

Charts #

Prometheus alerts are available as Helm chart:

ComponentChart URLWebsiteParameters
RDSoci://public.ecr.aws/qonto/prometheus-rds-alerts-chartLinkLink
PostgreSQLoci://public.ecr.aws/qonto/prometheus-postgresql-alerts-chartLinkLink