Skip to content

Commit e10ffc8

Browse files
schakkoschakko
committed
fix: metrics naming updated
Signed-off-by: Christopher Klein <ckl@dreitier.com>
1 parent 1b7b25c commit e10ffc8

File tree

1 file changed

+30
-29
lines changed

1 file changed

+30
-29
lines changed

‎docs/20-reference/metrics.md

Lines changed: 30 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -60,9 +60,9 @@ Reports the desired file count, as specified by the `retention-count` setting in
6060

6161
Reports the actual file count.
6262

63-
When purging is enabled, this count will usually be equal to the [target](#backmon_backup_file_count_aim).
63+
When purging is enabled, this count will usually be equal to the [target](#backmon_backup_file_count_max).
6464

65-
### `backmon_backup_file_age_aim_seconds`
65+
### `backmon_backup_file_age_max_seconds`
6666

6767
This is equal to the converted `retention-age` parameter in seconds from the [
6868
`backup_definitions.yaml`](backup-definition/overview)
@@ -116,21 +116,22 @@ have the same value/timestamp.
116116

117117
The following table shows which labels are defined for each metric.
118118

119-
| Metric | disk | dir | file | group |
120-
|:---------------------------------------------|:----:|:---:|:----:|:-----:|
121-
| `backmon_definition_status` | ✓ | - | - | - |
122-
| `backmon_backup_file_count_aim` | ✓ | ✓ | ✓ | - |
123-
| `backmon_backup_file_count` | ✓ | ✓ | ✓ | ✓ |
124-
| `backmon_backup_file_age_aim_seconds` | ✓ | ✓ | ✓ | - |
125-
| `backmon_backup_file_young_count` | ✓ | ✓ | ✓ | ✓ |
126-
| `backmon_backup_latest_creation_aim_seconds` | ✓ | ✓ | ✓ | - |
127-
| `backmon_backup_latest_creation_seconds` | ✓ | ✓ | ✓ | ✓ |
128-
| `backmon_backup_latest_creation_duration` | ✓ | ✓ | ✓ | ✓ |
129-
| `backmon_backup_latest_file_born_at_timestamp_seconds` | ✓ | ✓ | ✓ | ✓ |
130-
| `backmon_backup_latest_file_modified_at_timestamp_seconds` | ✓ | ✓ | ✓ | ✓ |
131-
| `backmon_backup_latest_file_archived_at_timestamp_seconds` | ✓ | ✓ | ✓ | ✓ |
132-
| `backmon_backup_latest_creation_seconds` | ✓ | ✓ | ✓ | ✓ |
133-
| `backmon_backup_latest_size_bytes` | ✓ | ✓ | ✓ | ✓ |
119+
| Metric | disk | dir | file | group |
120+
|:-----------------------------------------------------------------------|:----:|:---:|:----:|:-----:|
121+
| `backmon_definition_status` | ✓ | - | - | - |
122+
| `backmon_disk_usage_bytes` | ✓ | - | - | - |
123+
| `backmon_disk_quota_bytes` | ✓ | - | - | - |
124+
| `backmon_backup_file_count_max` | ✓ | ✓ | ✓ | - |
125+
| `backmon_backup_file_count` | ✓ | ✓ | ✓ | ✓ |
126+
| `backmon_file_count_total` | ✓ | ✓ | ✓ | ✓ |
127+
| `backmon_backup_file_age_max_seconds` | ✓ | ✓ | ✓ | - |
128+
| `backmon_backup_file_young_count` | ✓ | ✓ | ✓ | ✓ |
129+
| `backmon_backup_latest_file_creation_expected_at_timestamp_seconds` | ✓ | ✓ | ✓ | - |
130+
| `backmon_backup_latest_file_creation_duration` | ✓ | ✓ | ✓ | ✓ |
131+
| `backmon_backup_latest_file_born_at_timestamp_seconds` | ✓ | ✓ | ✓ | ✓ |
132+
| `backmon_backup_latest_file_modified_at_timestamp_seconds` | ✓ | ✓ | ✓ | ✓ |
133+
| `backmon_backup_latest_file_archived_at_timestamp_seconds` | ✓ | ✓ | ✓ | ✓ |
134+
| `backmon_backup_latest_size_bytes` | ✓ | ✓ | ✓ | ✓ |
134135

135136
## Sample output from the `/api/metrics` endpoint
136137

@@ -141,24 +142,24 @@ backmon_disks_total 0
141142
# HELP backmon_environments_total Total number of environments
142143
# TYPE backmon_environments_total gauge
143144
backmon_environments_total 1
144-
# HELP backmon_backup_file_age_aim_seconds The maximum age (in seconds) that any file in this group should reach.
145-
# TYPE backmon_backup_file_age_aim_seconds gauge
146-
backmon_backup_file_age_aim_seconds{dir="postgres",disk="samples/1.postgres-dumps",file="pgdump"} 0
145+
# HELP backmon_backup_file_age_max_seconds The maximum age (in seconds) that any file in this group should reach.
146+
# TYPE backmon_backup_file_age_max_seconds gauge
147+
backmon_backup_file_age_max_seconds{dir="postgres",disk="samples/1.postgres-dumps",file="pgdump"} 0
147148
# HELP backmon_backup_file_count The amount of backup files present in this group.
148149
# TYPE backmon_backup_file_count gauge
149150
backmon_backup_file_count{dir="postgres",disk="samples/1.postgres-dumps",file="pgdump",group="backups"} 4
150-
# HELP backmon_backup_file_count_aim The amount of backup files expected to be present in this group.
151-
# TYPE backmon_backup_file_count_aim gauge
152-
backmon_backup_file_count_aim{dir="postgres",disk="samples/1.postgres-dumps",file="pgdump"} 0
151+
# HELP backmon_backup_file_count_max The amount of backup files expected to be present in this group.
152+
# TYPE backmon_backup_file_count_max gauge
153+
backmon_backup_file_count_max{dir="postgres",disk="samples/1.postgres-dumps",file="pgdump"} 0
153154
# HELP backmon_backup_file_young_count The amount of backup files in this group that are younger than the maximum age (file_age_aim_seconds).
154155
# TYPE backmon_backup_file_young_count gauge
155156
backmon_backup_file_young_count{dir="postgres",disk="samples/1.postgres-dumps",file="pgdump",group="backups"} 0
156-
# HELP backmon_backup_latest_creation_aim_seconds Unix timestamp on which the latest backup in the corresponding file group should have occurred.
157-
# TYPE backmon_backup_latest_creation_aim_seconds gauge
158-
backmon_backup_latest_creation_aim_seconds{dir="postgres",disk="samples/1.postgres-dumps",file="pgdump"} 1.6581852e+09
159-
# HELP backmon_backup_latest_creation_seconds Unix timestamp on which the latest backup in the corresponding file group was created.
160-
# TYPE backmon_backup_latest_creation_seconds gauge
161-
backmon_backup_latest_creation_seconds{dir="postgres",disk="samples/1.postgres-dumps",file="pgdump",group="backups"} 1.658182599e+09
157+
# HELP backmon_backup_latest_file_creation_expected_at_timestamp_seconds Unix timestamp on which the latest backup in the corresponding file group should have occurred.
158+
# TYPE backmon_backup_latest_file_creation_expected_at_timestamp_seconds gauge
159+
backmon_backup_latest_file_creation_expected_at_timestamp_seconds{dir="postgres",disk="samples/1.postgres-dumps",file="pgdump"} 1.6581852e+09
160+
# HELP backmon_backup_latest_file_created_at_timestamp_seconds Unix timestamp on which the latest backup in the corresponding file group was created.
161+
# TYPE backmon_backup_latest_file_created_at_timestamp_seconds gauge
162+
backmon_backup_latest_file_created_at_timestamp_seconds{dir="postgres",disk="samples/1.postgres-dumps",file="pgdump",group="backups"} 1.658182599e+09
162163
# HELP backmon_backup_latest_file_archived_at_timestamp_seconds Unix timestamp on which the latest file has been archived
163164
# TYPE backmon_backup_latest_file_archived_at_timestamp_seconds gauge
164165
backmon_backup_latest_file_archived_at_timestamp_seconds{dir="postgres",disk="samples/1.postgres-dumps",file="pgdump",group="backups"} 1.381818188e+09

0 commit comments

Comments
 (0)