Skip to content

Commit

Permalink
Update README.
Browse files Browse the repository at this point in the history
  • Loading branch information
woblerr committed Aug 12, 2024
1 parent fcc87e7 commit 6f77bad
Showing 1 changed file with 7 additions and 0 deletions.
7 changes: 7 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@ To get a dashboard for visualizing the collected metrics, you can use a ready-ma
| ----------- | ------------------ | ------------- | --------------- |
| `pgbackrest_backup_annotations` | number of annotations in backup | backup_name, backup_type, database_id, block_incr, repo_key, stanza | |
| `pgbackrest_backup_databases` | number of databases in backup | backup_name, backup_type, block_incr, database_id, repo_key, stanza | |
| `pgbackrest_backup_references` | number of references to another backup (backup reference list) | backup_name, backup_type, block_incr, database_id, ref_backup, repo_key, stanza | |
| `pgbackrest_backup_duration_seconds` | backup duration in seconds | backup_name, backup_type, block_incr, database_id, repo_key, stanza, start_time, stop_time | |
| `pgbackrest_backup_error_status` | backup error status | backup_name, backup_type, block_incr, database_id, repo_key, stanza | Values description:<br> `0` - backup doesn't contain page checksum errors,<br> `1` - backup contains one or more page checksum errors. To display the list of errors, you need manually run the command like `pgbackrest info --stanza stanza --set backup_name --repo repo_key`. |
| `pgbackrest_backup_info` | backup info | backrest_ver, backup_name, backup_type, block_incr, database_id, lsn_start, lsn_stop, pg_version, prior, repo_key, stanza, wal_start, wal_stop | Values description:<br> `1` - info about backup is exist. |
Expand All @@ -51,6 +52,7 @@ To get a dashboard for visualizing the collected metrics, you can use a ready-ma
| `pgbackrest_backup_since_last_completion_seconds` | seconds since the last completed full, differential or incremental backup | backup_type, block_incr, stanza | |
| `pgbackrest_backup_last_annotations` | number of annotations in the last full, differential or incremental backup | backup_type, block_incr, stanza | |
| `pgbackrest_backup_last_databases` | number of databases in the last full, differential or incremental backup | backup_type, block_incr, stanza | |
| `pgbackrest_backup_last_references` | number of references to another backup (backup reference list) in the last full, differential or incremental backup | backup_type, block_incr, ref_backup, stanza | |
| `pgbackrest_backup_last_duration_seconds` | backup duration for the last full, differential or incremental backup | backup_type, block_incr, stanza | |
| `pgbackrest_backup_last_error_status` | error status in the last full, differential or incremental backup | backup_type, block_incr, stanza | |
| `pgbackrest_backup_last_delta_bytes` | amount of data in the database to actually backup in the last full, differential or incremental backup | backup_type, block_incr, stanza | |
Expand Down Expand Up @@ -182,6 +184,8 @@ Flags:
Number of parallel processes for collecting information about databases.
--[no-]backrest.database-count-latest
Exposing the number of databases in the latest backups.
--[no-]backrest.reference-count
Exposing the number of references to another backups (backup reference list).
--[no-]backrest.verbose-wal
Exposing additional labels for WAL metrics.
--log.level=info Only log messages with the given severity or above. One of: [debug, info, warn, error]
Expand Down Expand Up @@ -234,6 +238,9 @@ This flag works for `pgBackRest >= v2.41`.<br>
For earlier pgBackRest versions there will be an error like: `option 'set' is currently only valid for text output`.<br>
For a significant number of stanzas, this may require additional time to collect metrics. Each stanza requires pgBackRest execution for the last full, differential or incremental backups to get data.

When the `--backrest.reference-count` flag is specified, information about the number of references to other backups (backup reference list) is collected.<br>
The `pgbackrest_backup_references` metric can be a little annoying. This metric is hidden behind the flag. However, the `pgbackrest_backup_last_references` metric is always collected for the latest backups.

### Building and running docker

By default, pgBackRest version is `2.53`. Another version can be specified via arguments.
Expand Down

0 comments on commit 6f77bad

Please sign in to comment.