Lifecycle ping documentation example for container-db-backup

[bartekrutkowski]

Hi,

I'm Bartek Rutkowski, founder of Watchgoose.com, a platform for monitoring cron/kubernetes/backup jobs and other scheduled tasks.

I've checked release 4.1.100's per job script directories, it seems that executable .sh files under DB01_SCRIPT_LOCATION_PRE run before a supported backup, while files under DB01_SCRIPT_LOCATION_POST receive the dump status as $1 and the final move or upload status as $11.

watchgoose/pre/watchgoose.sh:

#!/bin/sh
[ -n "${WATCHGOOSE_PING_URL:-}" ] || exit 0
curl --fail --silent --show-error --connect-timeout 3 --max-time 10 \
  --request POST "${WATCHGOOSE_PING_URL%/}/start" >/dev/null 2>&1 || true
exit 0

watchgoose/post/watchgoose.sh:

#!/bin/sh
[ -n "${WATCHGOOSE_PING_URL:-}" ] || exit 0
endpoint="${WATCHGOOSE_PING_URL%/}/fail"
[ "${1:-}" = 0 ] && [ "${11:-}" = 0 ] && endpoint="${WATCHGOOSE_PING_URL%/}"
curl --fail --silent --show-error --connect-timeout 3 --max-time 10 \
  --request POST "$endpoint" >/dev/null 2>&1 || true
exit 0

environment:
  WATCHGOOSE_PING_URL: https://watchgoose.com/ping/<uuid>
  DB01_SCRIPT_LOCATION_PRE: /opt/watchgoose/pre
  DB01_SCRIPT_LOCATION_POST: /opt/watchgoose/post
  DB01_SPLIT_DB: "FALSE"
  DB01_BACKUP_GLOBALS: "FALSE"
volumes:
  - ./watchgoose/pre:/opt/watchgoose/pre:ro
  - ./watchgoose/post:/opt/watchgoose/post:ro

With executable helper files, this gives one named, non split MySQL, PostgreSQL, MongoDB, or InfluxDB job a Watchgoose lifecycle. It detects missed runs, dump or move failures, and runs open beyond grace. The two arguments do not cover every encryption, checksum, or cleanup result, the other backend, split mode, and PostgreSQL-globals patterns need separate handling.

Would that scoped example be useful in the script-hook documentation? I can provide it in the project preferred Compose format.

Also, Watchgoose has an Open Source support pledge where qualifying Open Source projects and nonprofits may receive a needs matched paid plan for free. I would be happy to arrange that for DBackup own scheduled infrastructure if you'd find that useful.

Kind regards,
Bartek Rutkowski