Change heuristic for "--successful" to really recognize checkpoint archives. #433

New Issue

Closed

opened 2021-07-20 05:46:43 +00:00 by ams_tschoening · 2 comments

ams_tschoening commented 2021-07-20 05:46:43 +00:00

Copy Link

What I'm trying to do and why

I would like to get a summary by mail about the last successful backup and in theory BorgMatic supports that use case with the following command already:

borgmatic list --successful --last 1 --json

The problem is that my archive name is the following:

archive_name_format: 'org.example.host-{utcnow:%Y%m%dT%H%M%S.%fZ}'

Recognize the Z at the end of the name to better describe the timestamp. I don't think that format is that uncommon, though it's not documented to be recognized. Instead of trying to detect something like a timestamp or alike at the end of archives, I suggest to simply stick to what Borg documents for checkpoints already:

During a backup a special checkpoint archive named .checkpoint is saved every checkpoint interval (the default value for this is 30 minutes) containing all the data backed-up until that point.

Searching for something like .checkpoint seems safer to me: It's the documented phrase Borg uses for checkpoints and is less likely to be used in archive names than timestamps like in my UTC-format.

Thanks for considering!

Environment

borgmatic version: 1.5.15
borgmatic installation method: PIP, system wide
Borg version: 1.1.16
Python version: 3.8.10
operating system and version: Ubuntu 20.04

#### What I'm trying to do and why I would like to get a summary by mail about the last successful backup and in theory BorgMatic supports that use case with the [following command already](https://torsion.org/borgmatic/docs/how-to/monitor-your-backups/#successful-backups): borgmatic list --successful --last 1 --json The problem is that my archive name is the following: archive_name_format: 'org.example.host-{utcnow:%Y%m%dT%H%M%S.%fZ}' Recognize the `Z` at the end of the name to better describe the timestamp. I don't think that format is that uncommon, though it's not documented to be recognized. Instead of trying to detect something like a timestamp or alike at the end of archives, I suggest to simply stick to what [Borg documents for checkpoints](https://borgbackup.readthedocs.io/en/stable/faq.html#checkpoints-parts) already: > During a backup a special checkpoint archive named <archive-name>.checkpoint is saved every checkpoint interval (the default value for this is 30 minutes) containing all the data backed-up until that point. Searching for something like `.checkpoint` seems safer to me: It's the documented phrase Borg uses for checkpoints and is less likely to be used in archive names than timestamps like in my UTC-format. **Thanks for considering!** #### Environment **borgmatic version:** 1.5.15 **borgmatic installation method:** PIP, system wide **Borg version:** 1.1.16 **Python version:** 3.8.10 **operating system and version:** Ubuntu 20.04

ams_tschoening commented 2021-07-23 14:59:48 +00:00

Author

Copy Link

By coincidence I got a checkpoint archive in the logs:

Starting archive consistency check...
TAM-verified manifest
Analyzing archive arch-20210722T163533.367211Z.checkpoint (1/2)
Analyzing archive arch-20210723T060528.747171Z (2/2)

Though, checking for the suffix .checkpoint only is not sufficient, it might contain some index as well:

The archive name needs to be unique. It must not end in ‘.checkpoint’ or ‘.checkpoint.N’ (with N being a number), because these names are used for checkpoints and treated in special ways.

https://borgbackup.readthedocs.io/en/stable/usage/create.html#description

By coincidence I got a checkpoint archive in the logs: ```bash Starting archive consistency check... TAM-verified manifest Analyzing archive arch-20210722T163533.367211Z.checkpoint (1/2) Analyzing archive arch-20210723T060528.747171Z (2/2) ``` Though, checking for the suffix `.checkpoint` only is not sufficient, it might contain some index as well: > The archive name needs to be unique. It must not end in ‘.checkpoint’ or ‘.checkpoint.N’ (with N being a number), because these names are used for checkpoints and treated in special ways. https://borgbackup.readthedocs.io/en/stable/usage/create.html#description

witten commented 2023-03-27 19:07:53 +00:00

Owner

Copy Link

I apologize for the lengthy delay in responding to this. The good news: --successful is deprecated and newer versions of Borg only show non-checkpoint archives by default!

I apologize for the lengthy delay in responding to this. The good news: `--successful` is deprecated and newer versions of Borg only show non-checkpoint archives by default!

witten closed this issue 2023-03-27 19:07:53 +00:00

Sign in to join this conversation.

No Branch/Tag Specified

Branches Tags

main

spot-check

1.8.11

1.8.10

1.8.9

1.8.8

1.8.7

1.8.6

1.8.5

1.8.4

1.8.3

1.8.2

1.8.1

1.8.0

1.7.15

1.7.14

1.7.13

1.7.12

1.7.11

1.7.10

1.7.9

1.7.8

1.7.7

1.7.6

1.7.5

1.7.4

1.7.3

1.7.2

1.7.1

1.7.0

1.6.6

1.6.5

1.6.4

1.6.3

1.6.2

1.6.1

1.6.0

1.5.24

1.5.23

1.5.22

1.5.21

1.5.20

1.5.19

1.5.18

1.5.17

1.5.16

1.5.15

1.5.14

1.5.13

1.5.12

1.5.11

1.5.10

1.5.9

1.5.8

1.5.7

1.5.7.dev0

1.5.6

1.5.5

1.5.4

1.5.3

1.5.2

1.5.1

1.5.0

1.4.22

1.4.21

1.4.20

1.4.19

1.4.18

1.4.17

1.4.16

1.4.15

1.4.14

1.4.13

1.4.12

1.4.11

1.4.10

1.4.9

1.4.8

1.4.7

1.4.6

1.4.5

1.4.4

1.4.3

1.4.2

1.4.1

1.4.0

1.3.26

1.3.25

1.3.24

1.3.23

1.3.22

1.3.21

1.3.20

1.3.19

1.3.18

1.3.17

1.3.16

1.3.15

1.3.14

1.3.13

1.3.12

1.3.11

1.3.10

1.3.9

1.3.8

1.3.7

1.3.6

1.3.5

1.3.4

1.3.3

1.3.2

1.3.1

1.3.0

1.2.18

1.2.17

1.2.16

1.2.15

1.2.14

1.2.13

1.2.12

1.2.11

1.2.10

1.2.9

1.2.8

1.2.7

1.2.6

1.2.5

1.2.4

1.2.3

1.2.2

1.2.1

1.2.0

1.1.15

1.1.14

1.1.13

1.1.12

1.1.11

1.1.10

1.1.9

1.1.7

1.1.6

1.1.5

1.1.4

1.1.3

1.1.2

1.1.1

1.1.0

1.0.3

1.0.2

1.0.1

1.0.0

0.1.8

0.1.7

0.1.6

0.1.5

0.1.4

0.1.3

0.1.2

0.1.1

0.1.0

0.0.7

0.0.6

0.0.5

0.0.4

0.0.3

0.0.2

Labels

Clear labels   

bug

  

data loss

  

design finalized

  

good first issue

  

new feature area

  

question / support

  

security

  

waiting for response

No Label

bug

data loss

design finalized

good first issue

new feature area

question / support

security

waiting for response

Milestone

Clear milestone

No items

No Milestone

Assignees

Clear assignees

No Assignees

2 Participants

Notifications

Subscribe

Due Date

The due date is invalid or out of range. Please use the format 'yyyy-mm-dd'.

No due date set.

Dependencies

No dependencies set.

Reference: borgmatic-collective/borgmatic#433

No description provided.