In documentation, clarify when Healthchecks/Cronitor hooks fire in relation to other hooks (#238).
This commit is contained in:
parent
2115eeb6a2
commit
31d3bc9bd8
3 changed files with 26 additions and 9 deletions
1
NEWS
1
NEWS
|
@ -1,4 +1,5 @@
|
||||||
1.4.7
|
1.4.7
|
||||||
|
* #238: In documentation, clarify when Healthchecks/Cronitor hooks fire in relation to other hooks.
|
||||||
* #239: Upgrade your borgmatic configuration to get new options and comments via
|
* #239: Upgrade your borgmatic configuration to get new options and comments via
|
||||||
"generate-borgmatic-config --source". See the documentation for more information:
|
"generate-borgmatic-config --source". See the documentation for more information:
|
||||||
https://torsion.org/borgmatic/docs/how-to/upgrade/#upgrading-your-configuration
|
https://torsion.org/borgmatic/docs/how-to/upgrade/#upgrading-your-configuration
|
||||||
|
|
|
@ -439,13 +439,17 @@ map:
|
||||||
desc: |
|
desc: |
|
||||||
Healthchecks ping URL or UUID to notify when a backup begins, ends, or errors.
|
Healthchecks ping URL or UUID to notify when a backup begins, ends, or errors.
|
||||||
Create an account at https://healthchecks.io if you'd like to use this service.
|
Create an account at https://healthchecks.io if you'd like to use this service.
|
||||||
|
See http://localhost:8080/docs/how-to/monitor-your-backups/#healthchecks-hook
|
||||||
|
for details.
|
||||||
example:
|
example:
|
||||||
https://hc-ping.com/your-uuid-here
|
https://hc-ping.com/your-uuid-here
|
||||||
cronitor:
|
cronitor:
|
||||||
type: str
|
type: str
|
||||||
desc: |
|
desc: |
|
||||||
Cronitor ping URL to notify when a backup begins, ends, or errors. Create an
|
Cronitor ping URL to notify when a backup begins, ends, or errors. Create an
|
||||||
account at https://cronitor.io if you'd like to use this service.
|
account at https://cronitor.io if you'd like to use this service. See
|
||||||
|
http://localhost:8080/docs/how-to/monitor-your-backups/#cronitor-hook for
|
||||||
|
details.
|
||||||
example:
|
example:
|
||||||
https://cronitor.link/d3x0c1
|
https://cronitor.link/d3x0c1
|
||||||
before_everything:
|
before_everything:
|
||||||
|
|
|
@ -111,9 +111,15 @@ hooks:
|
||||||
healthchecks: https://hc-ping.com/addffa72-da17-40ae-be9c-ff591afb942a
|
healthchecks: https://hc-ping.com/addffa72-da17-40ae-be9c-ff591afb942a
|
||||||
```
|
```
|
||||||
|
|
||||||
With this hook in place, borgmatic will ping your Healthchecks project when a
|
With this hook in place, borgmatic pings your Healthchecks project when a
|
||||||
backup begins, ends, or errors. Then you can configure Healthchecks to notify
|
backup begins, ends, or errors. Specifically, before the <a
|
||||||
you by a [variety of
|
href="https://torsion.org/borgmatic/docs/how-to/add-preparation-and-cleanup-steps-to-backups/">`before_backup`
|
||||||
|
hooks</a> run, borgmatic lets Healthchecks know that a backup has started.
|
||||||
|
Then, if the backup completes successfully, borgmatic notifies Healthchecks of
|
||||||
|
the success after the `after_backup` hooks run. And if an error occurs during
|
||||||
|
the backup, borgmatic notifies Healthchecks after the `on_error` hooks run.
|
||||||
|
|
||||||
|
You can configure Healthchecks to notify you by a [variety of
|
||||||
mechanisms](https://healthchecks.io/#welcome-integrations) when backups fail
|
mechanisms](https://healthchecks.io/#welcome-integrations) when backups fail
|
||||||
or it doesn't hear from borgmatic for a certain period of time.
|
or it doesn't hear from borgmatic for a certain period of time.
|
||||||
|
|
||||||
|
@ -132,11 +138,17 @@ hooks:
|
||||||
cronitor: https://cronitor.link/d3x0c1
|
cronitor: https://cronitor.link/d3x0c1
|
||||||
```
|
```
|
||||||
|
|
||||||
With this hook in place, borgmatic will ping your Cronitor monitor when a
|
With this hook in place, borgmatic pings your Cronitor monitor when a backup
|
||||||
backup begins, ends, or errors. Then you can configure Cronitor to notify you
|
begins, ends, or errors. Specifically, before the <a
|
||||||
by a [variety of
|
href="https://torsion.org/borgmatic/docs/how-to/add-preparation-and-cleanup-steps-to-backups/">`before_backup`
|
||||||
mechanisms](https://cronitor.io/docs/cron-job-notifications) when backups
|
hooks</a> run, borgmatic lets Cronitor know that a backup has started. Then,
|
||||||
fail or it doesn't hear from borgmatic for a certain period of time.
|
if the backup completes successfully, borgmatic notifies Cronitor of the
|
||||||
|
success after the `after_backup` hooks run. And if an error occurs during the
|
||||||
|
backup, borgmatic notifies Cronitor after the `on_error` hooks run.
|
||||||
|
|
||||||
|
You can configure Cronitor to notify you by a [variety of
|
||||||
|
mechanisms](https://cronitor.io/docs/cron-job-notifications) when backups fail
|
||||||
|
or it doesn't hear from borgmatic for a certain period of time.
|
||||||
|
|
||||||
|
|
||||||
## Scripting borgmatic
|
## Scripting borgmatic
|
||||||
|
|
Loading…
Reference in a new issue