Skip to content

Commit 8beff9f

Browse files
committed
doc: update docs
1 parent 413b4f5 commit 8beff9f

File tree

3 files changed

+13
-2
lines changed

3 files changed

+13
-2
lines changed

docs/explanation/architecture.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,12 +33,13 @@ Service Startup Current Notes
3333
charmed-postgresql.patroni enabled active -
3434
charmed-postgresql.pgbackrest-service enabled active -
3535
charmed-postgresql.prometheus-postgres-exporter enabled active -
36+
charmed-postgresql.pgbackrest-exporter enabled active -
3637
3738
```
3839

3940
The `patroni` snap service is a main PostgreSQL instance which is normally up and running right after the charm deployment.
4041

41-
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.
42+
The `pgbackrest` snap servics 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.
4243

4344
The `prometheus-postgres-exporter` service is activated after the relation with [COS Monitoring](/how-to/monitoring-cos/enable-monitoring) only.
4445

docs/reference/alert-rules.md

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,8 +48,17 @@ This page contains a markdown version of the alert rules described in the `postg
4848
| PatroniPostgresqlDown | ![critical] | Patroni PostgreSQL instance is down.<br>Check for errors in the Loki logs. |
4949
| 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. |
5050

51+
## `PgbackrestExporterK8s`
52+
53+
| Alert | Severity | Notes |
54+
| ----- | -------- | ----- |
55+
| `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. |
56+
| `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. |
57+
| `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. |
58+
| `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. |
59+
| `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. |
60+
5161
<!-- Badges -->
5262
[info]: https://img.shields.io/badge/info-blue
5363
[warning]: https://img.shields.io/badge/warning-yellow
5464
[critical]: https://img.shields.io/badge/critical-red
55-

docs/reference/troubleshooting/index.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -83,6 +83,7 @@ Service Startup Current Notes
8383
charmed-postgresql.patroni enabled active -
8484
charmed-postgresql.pgbackrest-service enabled active -
8585
charmed-postgresql.prometheus-postgres-exporter enabled active -
86+
charmed-postgresql.pgbackrest-exporter enabled active -
8687
8788
ubuntu@juju-fd7874-0:~$ systemctl --failed
8889
...

0 commit comments

Comments
 (0)