Skip to content

docs(wiki): document behavior when storage is unavailable (#633) - #643

Merged
oluciano merged 1 commit into
developfrom
docs/633-storage-unavailable
Oct 19, 2026
Merged

oluciano merged 1 commit into
developfrom
docs/633-storage-unavailable

Conversation

@oluciano

Copy link
Copy Markdown
Owner

Summary

Documents what the code does when the database is down or fails over: dispatcher fetch, job and node heartbeats, orphan watcher, enqueue, and HeartbeatTimeout guidance. Only facts proven by the code are written; each was checked at its source location. Behavior that is suspected to be a defect is not described as behavior and is tracked separately.

Type of change

  • Documentation

Verification Checklist

  • DocsTruth --strict: 0 drift
  • mkdocs build --strict passes
  • CHANGELOG.md updated under [Unreleased]
  • No src/ or tests changed

Not covered by this PR

No test cuts a real database connection, so the page says the behavior comes from code reading and mock-based unit tests (listed in how-we-test). Open points: #640 (dispatcher loop ends if the runtime settings read throws), #641 (failure commit has no retry), #642 (candidate risks to reproduce).

Closes #633

- delivery-guarantees: 'When storage is unavailable' section (dispatcher, heartbeats, orphan watcher, enqueue, HeartbeatTimeout guidance)
- troubleshooting: database outage entry with the real log messages
- how-we-test: an outage is not covered by provider tests
- storage pages link to the new section
@sonarqubecloud

Copy link
Copy Markdown

@oluciano
oluciano merged commit d4a7596 into develop Oct 19, 2026
61 of 62 checks passed
@oluciano
oluciano deleted the docs/633-storage-unavailable branch October 19, 2026 16:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: document behavior when the storage is unavailable (outage, failover)

1 participant