Skip to content

doc: Include Watchgoose in cron monitoring options #645

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
notheotherben merged 1 commit into from
Jul 23, 2026
Merged

doc: Include Watchgoose in cron monitoring options #645

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 18 additions & 2 deletions docs/guide/monitors.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@
GitHub Backup is designed to run unattended on a schedule, which makes it
important to know when a backup run fails to start or complete. To support this,
GitHub Backup can report the state of each scheduled run to an HTTP-based cron
monitoring service such as [Sentry Cron Monitors](https://docs.sentry.io/product/crons/)
or [healthchecks.io](https://healthchecks.io/).
monitoring service such as [Sentry Cron Monitors](https://docs.sentry.io/product/crons/),
[Watchgoose](https://watchgoose.com) or [healthchecks.io](https://healthchecks.io/).

Whenever a backup run starts or completes, GitHub Backup will make a simple HTTP
`GET` request to the URL you've configured for that state, allowing your
Expand Down Expand Up @@ -57,6 +57,22 @@ ping:
failure: https://sentry.io/api/0/organizations/your-org/monitors/github-backup/checkins/?status=error
```

### Watchgoose
[Watchgoose](https://watchgoose.com/) provides a base ping URL, with
`/start` and `/fail` suffixes used to signal the start and failure of a run.
Create a check in Watchgoose, copy its ping URL, and configure it as follows:

```yaml
ping:
start: https://watchgoose.com/ping/your-uuid-here/start
success: https://watchgoose.com/ping/your-uuid-here
failure: https://watchgoose.com/ping/your-uuid-here/fail
```

Set the check's expected schedule and grace period to match the backup schedule.
Watchgoose can then alert when a run fails explicitly, does not arrive, or starts
but exceeds the configured runtime grace period.

### healthchecks.io
[healthchecks.io](https://healthchecks.io/) provides a base ping URL, with
`/start` and `/fail` suffixes used to signal the start and failure of a run.
Expand Down