docs: mark proc.heartbeat_sync_interval as ignored

Merged
SC
7h ago
+8-9

Summary

proc.heartbeat_sync_interval and its scheduler.* alias were removed from the loader in dagucloud/dagu#2507. The config schema now describes them as "Deprecated and ignored. Accepted so existing configuration files remain valid.", and DAGU_PROC_HEARTBEAT_SYNC_INTERVAL / DAGU_SCHEDULER_HEARTBEAT_SYNC_INTERVAL are no longer bound. The docs still describe an fsync interval with a 10s default and use it in the timing invariant.

Changes

  • writing-workflows/scheduling.md: the zombie detection section says how the heartbeat is written now (temporary file, fsync, rename on every write), drops the key from both configuration examples, states the timing invariant against proc.heartbeat_interval (Dagu refuses to start when it is not less than proc.stale_threshold), and says the old key is ignored.
  • server-admin/reference.md: drops the key from the YAML example and the two environment variables from the Proc Liveness list, and says that the keys are ignored and the variables are no longer read.

Related Issues

Follow-up to dagucloud/dagu#2507.

Checks

  • node scripts/validate-examples.mjs with Dagu built from main (0689a90): 912 examples validated
  • pnpm build
  • pnpm test:worker
  • git diff --check
  • With Dagu main: a config that sets proc.heartbeat_sync_interval and scheduler.heartbeat_sync_interval loads and runs a DAG; proc.heartbeat_interval: 100s with proc.stale_threshold: 90s stops with proc.heartbeat_interval (1m40s) must be less than proc.stale_threshold (1m30s).

Summary by cubic

Updates the docs to reflect that proc.heartbeat_sync_interval and its scheduler.* alias are now ignored: they were removed from the loader in dagucloud/dagu#2507, so setting them has no effect and DAGU_PROC_HEARTBEAT_SYNC_INTERVAL / DAGU_SCHEDULER_HEARTBEAT_SYNC_INTERVAL are no longer read. Also fixes the zombie detection timing invariant, which previously compared proc.stale_threshold against the sync interval instead of proc.heartbeat_interval, and drops the key from configuration examples, the reference YAML, and the environment variable list.