Merge branch '16/edge' into prefixes

Author: dragomirp

.github/workflows/ci.yaml

@@ -48,6 +48,20 @@ jobs:
         env:
           CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
 
+  alert-test:
+    name: Test Prometheus Alert Rules
+    runs-on: ubuntu-latest
+    timeout-minutes: 5
+    steps:
+      - name: Checkout repo
+        uses: actions/checkout@v5
+      - name: Install prometheus snap
+        run: sudo snap install prometheus
+      - name: Check validity of prometheus alert rules
+        run: promtool check rules src/prometheus_alert_rules/*
+      - name: Run unit tests for prometheus alert rules
+        run: promtool test rules tests/alerts/*.yaml
+
   build:
     name: Build charm
     uses: canonical/data-platform-workflows/.github/workflows/build_charm.yaml@v35.0.2

docs/.custom_wordlist.txt

@@ -87,6 +87,7 @@ Nextcloud
 otf
 Parca
 Parca's
+patroni
 Patroni
 patronictl
 performant

docs/explanation/architecture.md

@@ -50,13 +50,14 @@ charmed-postgresql.patroni                       enabled   active   -
 charmed-postgresql.pgbackrest-exporter           enabled   active   -
 charmed-postgresql.pgbackrest-service            enabled   active   -
 charmed-postgresql.prometheus-postgres-exporter  enabled   active   -
+charmed-postgresql.pgbackrest-exporter           enabled   active   -
 ```
 
 <!-- TODO: The `ldap-sync` service is... -->
 
 The `patroni` snap service is a main PostgreSQL instance which is normally up and running right after the charm deployment.
 
-The `pgbackrest` snap service is a backup framework for PostgreSQL. It is disabled if [backups](/how-to/back-up-and-restore/create-a-backup) are not configured.
+The `pgbackrest` snap service is a backup framework for PostgreSQL. It is disabled if [Backup](/how-to/back-up-and-restore/create-a-backup) is not configured along with the `pgbackrest-exporter` service.
 
 The `prometheus-postgres-exporter` service is activated after the relation with [COS Monitoring](/how-to/monitoring-cos/enable-monitoring) only.
 

docs/explanation/security/index.md

@@ -100,6 +100,12 @@ The following information is configured to be logged:
 
 Other events, like connections and disconnections, are logged depending on the value of the charm configuration options related to them. For more information, check the configuration options with the `logging` prefix in the [configuration reference](https://charmhub.io/postgresql/configurations#logging_log_connections).
 
+Also, all operations performed by the charm as a result of user actions — such as enabling or disabling plugins, managing TLS, creating or restoring backups, and configuring replication between clusters (asynchronous or logical) — are executed through the underlying workload components (PostgreSQL, Patroni, or pgBackRest). Consequently, these operations are recorded in the respective workload log files, which are accessible in the directories below and also forwarded to COS:
+
+* /var/snap/charmed-postgresql/common/var/log/patroni
+* /var/snap/charmed-postgresql/common/var/log/pgbackrest
+* /var/snap/charmed-postgresql/common/var/log/postgresql
+
 No secrets are logged.
 
 ## Additional resources

docs/reference/alert-rules.md

@@ -48,6 +48,16 @@ This page contains a markdown version of the alert rules described in the `postg
 | PatroniPostgresqlDown | ![critical] | Patroni PostgreSQL instance is down.<br>Check for errors in the Loki logs. |
 | PatroniHasNoLeader | ![critical] | Patroni instance has no leader node.<br>A leader node (neither primary nor standby) cannot be found inside a cluster.<br>Check for errors in the Loki logs. |
 
+## `PgbackrestExporter`
+
+| Alert | Severity | Notes |
+| ----- | -------- | ----- |
+| `PgBackRestBackupError` | ![critical] | Backup failed for a stanza.<br>The last pgBackRest backup ended with error status > 0.<br>Check the pgBackRest logs for the stanza. |
+| `PgBackRestBackupTooOld` | ![warning] | No recent backup available.<br>The last pgBackRest backup is older than 7 days.<br>Consider checking your backup schedule, capacity, and logs. |
+| `PgBackRestStanzaError` | ![warning] | A stanza has reported errors.<br>Status > 0 indicates problems such as missing stanza path or no valid backups.<br>Check pgBackRest logs for details. |
+| `PgBackRestRepoError` | ![warning] | A repository has reported errors.<br>Status > 0 indicates the repo may be inaccessible, out of space, or otherwise unhealthy.<br>Check pgBackRest logs and storage system. |
+| `PgBackRestExporterError` | ![critical] | The pgBackRest exporter failed to fetch data.<br>Metric `pgbackrest_exporter_status == 0` indicates exporter-side issues.<br>This may be a misconfiguration or runtime error; check exporter logs. |
+
 <!-- Badges -->
 [info]: https://img.shields.io/badge/info-blue
 [warning]: https://img.shields.io/badge/warning-yellow

docs/reference/troubleshooting/index.md

@@ -86,6 +86,7 @@ Service                                          Startup   Current   Notes
 charmed-postgresql.patroni                       enabled   active    -
 charmed-postgresql.pgbackrest-service            enabled   active    -
 charmed-postgresql.prometheus-postgres-exporter  enabled   active    -
+charmed-postgresql.pgbackrest-exporter           enabled   active    -
 
 ubuntu@juju-fd7874-0:~$ systemctl --failed
 ...