refactor(SQLExporter): Renamed in preparation for sql_exporter + warnings in tutorials added

Author: qfritz

.github/workflows/test.yaml

@@ -40,7 +40,7 @@ jobs:
     name: helm
     runs-on: ubuntu-latest
     env:
-      HELM_UNITTEST_VERSION: v0.3.5
+      HELM_UNITTEST_VERSION: v0.4.1
     steps:
       - uses: actions/checkout@v3
 

charts/prometheus-postgresql-alerts/prometheus_tests/PostgreSQLExporterDown.yml

@@ -5,13 +5,13 @@ evaluation_interval: 1m
 
 tests:
 
-    - name: PostgreSQLExporterDown
+    - name: SQLExporterDown
       interval: 1m
       input_series:
           - series: 'up{service="sql-exporter", target="mydatabase"}'
             values: '0x10'
       alert_rule_test:
-          - alertname: PostgreSQLExporterDown
+          - alertname: SQLExporterDown
             eval_time: 5m
             exp_alerts:
                 - exp_labels:
@@ -20,4 +20,4 @@ tests:
                   exp_annotations:
                       summary: "Exporter is down"
                       description: "SQL Exporter is down"
-                      runbook_url: "https://qonto.github.io/database-monitoring-framework/0.0.0/runbooks/postgresql/PostgreSQLExporterDown"
+                      runbook_url: "https://qonto.github.io/database-monitoring-framework/0.0.0/runbooks/postgresql/SQLExporterDown"

charts/prometheus-postgresql-alerts/prometheus_tests/PostgreSQLExporterMissingTarget.yml

@@ -5,15 +5,15 @@ evaluation_interval: 1m
 
 tests:
 
-    - name: PostgreSQLExporterMissingTarget
+    - name: SQLExporterMissingTarget
       interval: 1m
       input_series:
           - series: 'up{service="sql-exporter", target="db1", exported_job="pg-metrics-instance"}'
             values: '0x00'
           - series: 'up{service="sql-exporter", target="", exported_job="pg-metrics-instance"}'
             values: '0x10'
       alert_rule_test:
-          - alertname: PostgreSQLExporterMissingTarget
+          - alertname: SQLExporterMissingTarget
             eval_time: 5m
             exp_alerts:
                 - exp_labels:
@@ -23,4 +23,4 @@ tests:
                   exp_annotations:
                       summary: "Exporter scrape for db1 (pg-metrics-instance) failed"
                       description: "SQL Exporter cannot collect metrics for this target, it's either because the target is down, or the sql-exporter user cannot connect."
-                      runbook_url: "https://qonto.github.io/database-monitoring-framework/0.0.0/runbooks/postgresql/PostgreSQLExporterMissingTarget"
+                      runbook_url: "https://qonto.github.io/database-monitoring-framework/0.0.0/runbooks/postgresql/SQLExporterMissingTarget"

charts/prometheus-postgresql-alerts/prometheus_tests/PostgreSQLExporterScrapingLimit.yml

@@ -5,13 +5,13 @@ evaluation_interval: 1m
 
 tests:
 
-    - name: PostgreSQLExporterScrapingLimit
+    - name: SQLExporterScrapingLimit
       interval: 1m
       input_series:
           - series: 'scrape_duration_seconds{job="sql-exporter", target=""}'
             values: 40x10
       alert_rule_test:
-          - alertname: PostgreSQLExporterScrapingLimit
+          - alertname: SQLExporterScrapingLimit
             eval_time: 5m
             exp_alerts:
                 - exp_labels:
@@ -20,4 +20,4 @@ tests:
                   exp_annotations:
                       summary: "Exporter scraping takes long time"
                       description: "SQL Exporter scraping is taking a long time"
-                      runbook_url: "https://qonto.github.io/database-monitoring-framework/0.0.0/runbooks/postgresql/PostgreSQLExporterScrapingLimit"
+                      runbook_url: "https://qonto.github.io/database-monitoring-framework/0.0.0/runbooks/postgresql/SQLExporterScrapingLimit"

charts/prometheus-postgresql-alerts/values.yaml

@@ -10,7 +10,7 @@ rulesGroupName: postgresql.rules
 
 rules:
 
-  PostgreSQLExporterDown:
+  SQLExporterDown:
     expr: absent(up{service="sql-exporter", target=""})
     for: 5m
     labels:
@@ -19,7 +19,7 @@ rules:
       summary: "Exporter is down"
       description: "SQL Exporter is down"
 
-  PostgreSQLExporterMissingTarget:
+  SQLExporterMissingTarget:
     expr: min(up{service="sql-exporter", target!=""}) by (target,exported_job) < 1
     for : 5m
     labels:
@@ -28,7 +28,7 @@ rules:
       summary: "Exporter scrape for {{ $labels.target }} ({{ $labels.exported_job }}) failed"
       description: "SQL Exporter cannot collect metrics for this target, it's either because the target is down, or the sql-exporter user cannot connect."
 
-  PostgreSQLExporterScrapingLimit:
+  SQLExporterScrapingLimit:
     expr: avg_over_time(scrape_duration_seconds{job="sql-exporter", target=""}[10m]) > 30
     for: 5m
     labels:

content/architecture.md

@@ -19,6 +19,13 @@ This component is optional but highly recommended for AWS customers.
 
 ### Prometheus PostgreSQL exporter
 
+{{< hint info >}}
+**Tips**
+
+This section is outdated for DMF version >beta.10 because of ongoing migration toward burningalchemist/sql_exporter. Stay tuned!
+
+{{< /hint >}}
+
 The [Prometheus Postgres exporter](https://github.com/prometheus-community/postgres_exporter) collects PostgreSQL internal metrics using system tables.
 
 We override its default configuration to collect additional metrics to trigger advanced alerts and analyze trends over time.

content/runbooks/postgresql/PostgreSQLExporterDown.md renamed to content/runbooks/postgresql/SQLExporterDown.md

@@ -2,7 +2,7 @@
 title: Exporter down
 ---
 
-# PostgreSQLExporterDown
+# SQLExporterDown
 
 ## Meaning
 
@@ -14,14 +14,14 @@ The monitoring system is degraded. SQL exporter does not collect SQL metrics, al
 
 ## Diagnosis
 
-1. **Look at Prometheus SQL exporter logs**. The error messages (`level=error`) should explain why the exporter can't scrape metrics.
+1. **Look at SQL exporter logs**. The error messages (`level=error`) should explain why the exporter can't scrape metrics.
 
     Usually, the exporter can't connect to the PostgreSQL server due to network restrictions, authentication failure, missing permissions or timeout.
 
     {{< hint info >}}
 **PostgreSQL required permissions**
 
-The PostgreSQL exporter needs `pg_monitor` role and `LOGIN` options.
+The SQL exporter needs `pg_monitor` role and `LOGIN` options.
     {{< /hint >}}
 
 1. **Look at PostgreSQL connection logs**

content/runbooks/postgresql/PostgreSQLExporterMissingTarget.md renamed to content/runbooks/postgresql/SQLExporterMissingTarget.md

@@ -2,7 +2,7 @@
 title: Exporter target down
 ---
 
-# PostgreSQLExporterMissingTarget
+# SQLExporterMissingTarget
 
 ## Meaning
 
@@ -14,19 +14,19 @@ The monitoring system is degraded for this target. SQL exporter does not collect
 
 ## Diagnosis
 
-1. **Look at Prometheus SQL exporter logs**. The error messages (`level=error`) should explain why the exporter can't scrape metrics.
+1. **Look at SQL exporter logs**. The error messages (`level=error`) should explain why the exporter can't scrape metrics.
 
     Usually, the exporter can't connect to the PostgreSQL server due to network restrictions, authentication failure, missing permissions or timeout.
 
     {{< hint info >}}
 **PostgreSQL required permissions**
 
-The PostgreSQL exporter needs `pg_monitor` role and `LOGIN` options.
+The SQL exporter needs `pg_monitor` role and `LOGIN` options.
     {{< /hint >}}
 
 1. **Look at PostgreSQL connection logs**
 
-    You'll get an error message if PostgreSQL exporter connections are rejected by PostgreSQL.
+    You'll get an error message if SQL exporter connections are rejected by PostgreSQL.
 
 ## Mitigation
 

content/runbooks/postgresql/PostgreSQLExporterScrapingLimit.md renamed to content/runbooks/postgresql/SQLExporterScrapingLimit.md

@@ -2,7 +2,7 @@
 title: Exporter scraping limit
 ---
 
-# PostgreSQLExporterScrapingLimit
+# SQLExporterScrapingLimit
 
 ## Meaning
 

content/tutorials/postgresql/alerts-deployment.md

@@ -7,6 +7,13 @@ weight: 200
 
 In this tutorial, you'll deploy the alerts for PostgreSQL.
 
+{{< hint info >}}
+**Tips**
+
+This page is outdated for DMF version >beta.10 because of ongoing migration toward sql_exporter. Stay tuned!
+
+{{< /hint >}}
+
 ## Requirements
 
 - Helm (v3.0+)
@@ -23,7 +30,7 @@ This tutorial assumes you have Kubernetes, Helm and Prometheus knowledge.
 
     ```bash
     KUBERNETES_NAMESPACE=monitoring
-    helm upgrade --install prometheus-rds-alerts-chart oci://public.ecr.aws/qonto/prometheus-rds-alerts-chart:{{% current_version %}} --namespace ${KUBERNETES_NAMESPACE}
+    helm upgrade --install prometheus-postgresql-alerts-chart oci://public.ecr.aws/qonto/prometheus-rds-alerts-chart:{{% current_version %}} --namespace ${KUBERNETES_NAMESPACE}
     ```
 
 1. Connect on Prometheus and check rules are defined