Add option to disable Healthchecks ping on soft failure #1031

New issue

Closed

opened 2025-03-17 21:44:42 +00:00 by error4o4 · 3 comments

error4o4 commented 2025-03-17 21:44:42 +00:00

Copy link

What I'd like to do and why

In #842 a change was made to ping Healtchecks/monitoring with "finish" in the case of soft failure.

That makes sense in some cases, but not always.

I have two config files : one backups to a cloud service, and one to a USB disk. In the config for the USB disk, i use a before_backup hook to run findmnt and generate a soft failure (exit 75) if the USB disk is not mounted.
With borgmatic 1.9.13, it sends a ping to Healthchecks so the backup status is OK on Healthchecks, even though the backup didn't run.
I would like to be able to configure an option to make it revert to the old logic : only send the start ping to Healthchecks, no end ping, so Healthchecks will warn me if no backups finished successfully within the specified timeframe.

I guess I could achieve this with the backup_everything hook, but I can't because I still need borgmatic to run my other config file (cloud backup).

PS : the before: configuration hook, planned for borgmatic 2, should solve my problem. I don't know if it is going to be released soon, but this feature request will probably be obsolete with borgmatic 2.

Other notes / implementation ideas

No response

### What I'd like to do and why In https://projects.torsion.org/borgmatic-collective/borgmatic/issues/842 a change was made to ping Healtchecks/monitoring with "finish" in the case of soft failure. That makes sense in some cases, but not always. I have two config files : one backups to a cloud service, and one to a USB disk. In the config for the USB disk, i use a `before_backup` hook to run findmnt and generate a soft failure (`exit 75`) if the USB disk is not mounted. With borgmatic 1.9.13, it sends a ping to Healthchecks so the backup status is OK on Healthchecks, even though the backup didn't run. I would like to be able to configure an option to make it revert to the old logic : only send the start ping to Healthchecks, no end ping, so Healthchecks will warn me if no backups finished successfully within the specified timeframe. I guess I could achieve this with the `backup_everything` hook, but I can't because I still need borgmatic to run my other config file (cloud backup). PS : the `before: configuration` hook, planned for borgmatic 2, should solve my problem. I don't know if it is going to be released soon, but this feature request will probably be obsolete with borgmatic 2. ### Other notes / implementation ideas _No response_

witten commented 2025-03-18 00:23:19 +00:00

Owner

Copy link

Thanks for filing this. borgmatic 2 should be released within the next few weeks, and at minimum it is planned to be the next borgmatic release. So that should hopefully satisfy this need. But just to make sure: How do you envision the new before: configuration command hook solving this need? Is the ideas that you'd move your findmnt soft failure call to the before: configuration level?

Thanks for filing this. borgmatic 2 *should* be released within the next few weeks, and at minimum it is planned to be the next borgmatic release. So that should hopefully satisfy this need. But just to make sure: How do you envision the new `before: configuration` command hook solving this need? Is the ideas that you'd move your `findmnt` soft failure call to the `before: configuration` level?

error4o4 commented 2025-03-18 06:31:36 +00:00

Author

Copy link

Yes, if I move the findmnt soft failure call to the before: configuration level, the whole config for the USB disk will not run, so Healthchecks will get no ping for it, which is right : no backup happened.

My other config file (cloud backup) will run as usual and ping its own Healthchecks URL, so I will still know if it happened and completed successfully or not.

I tried the backup_everything hook with 1.9.13, its logic would be good for me if I had only the USB backup config, but I can't use it because it also skips my cloud backup. I guess this will be solved by the new before: configuration hook.

Yes, if I move the `findmnt` soft failure call to the `before: configuration` level, the whole config for the USB disk will not run, so Healthchecks will get no ping for it, which is right : no backup happened. My other config file (cloud backup) will run as usual and ping its own Healthchecks URL, so I will still know if it happened and completed successfully or not. I tried the `backup_everything` hook with 1.9.13, its logic would be good for me if I had only the USB backup config, but I can't use it because it also skips my cloud backup. I guess this will be solved by the new `before: configuration` hook.

witten commented 2025-03-18 17:11:26 +00:00

Owner

Copy link

Gotcha. Yes, looking at the code in main, before: configuration does respect the soft failure exit code and therefore won't ping any monitoring hooks like Healthchecks (for that configuration file) in that situation. So given that I think this satisfies your need, I'll close this ticket for now. But please let me know if it turns out the new hook does not meet your needs in practice. Thanks!

Gotcha. Yes, looking at the code in main, `before: configuration` does respect the soft failure exit code and therefore won't ping any monitoring hooks like Healthchecks (for that configuration file) in that situation. So given that I think this satisfies your need, I'll close this ticket for now. But please let me know if it turns out the new hook does not meet your needs in practice. Thanks!

witten closed this issue 2025-03-18 17:11:29 +00:00

Sign in to join this conversation.

No Branch/Tag specified

Branches Tags

main

parallel-borgmatic

command-hook-steps

2.1.7

2.1.6

2.1.5

2.1.4

2.1.3

2.1.2

2.1.1

2.1.0

2.0.13

2.0.12

2.0.11

2.0.10

2.0.9

2.0.8

2.0.7

2.0.6

2.0.5

2.0.4

2.0.3

2.0.2

2.0.1

2.0.0

1.9.14

1.9.13

1.9.12

1.9.11

1.9.10

1.9.9

1.9.8

1.9.7

1.9.6

1.9.5

1.9.4

1.9.3

1.9.2

1.9.1

1.9.0

1.8.14

1.8.13

1.8.12

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   

blocked

  

breaking

  

bug

  

data loss

  

design finalized

  

good first issue

  

new feature area

  

question / support

  

security

  

waiting for response

No labels

blocked

breaking

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#1031

No description provided.