Skip to content

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

Closed

Description

@oluciano

Found by the persona usability test of docs/wiki (docs/wiki-guardian-full-review): readers answered questions using only the wiki, without reading src/.

Gap (SRE persona, no answer in the wiki): nothing says what the dispatcher, the heartbeat and the enqueue do when the database goes away and comes back: does the host survive, does polling resume by itself, can HeartbeatTimeout requeue jobs that are still running during a long outage, what does the caller of EnqueueAsync see. Only Redis has a note, and it says failover was not tried. Postgres, SQL Server and MongoDB have nothing.

Work: read the dispatcher/heartbeat/enqueue code per provider, ideally prove it with an integration test (see the integration-tests-per-provider rule), then write a section 'When storage is unavailable' in concepts/delivery-guarantees.md and a one-line pointer in each storage page. No claim without code or test evidence.

Activity

  1. added
    documentationImprovements or additions to documentation
    backlogNice to have; not planned for any version
    in-progressWork currently in progress
    on Oct 19, 2026
  2. oluciano commented on Oct 19, 2026

    @oluciano
    OwnerAuthor

    Work Started (WIP)

  3. added a commit that references this issue on Oct 19, 2026
  4. added
    completedDelivered and verified in codebase
    and removed
    in-progressWork currently in progress
    on Oct 19, 2026
  5. oluciano commented on Oct 19, 2026

    @oluciano
    OwnerAuthor

    Acceptance & Resolution Statement

  6. added a commit that references this issue on Oct 19, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    backlogNice to have; not planned for any versioncompletedDelivered and verified in codebasedocumentationImprovements or additions to documentation

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions