Skip to content

feat(events) [STORY-4495] document the generic continuous backup status and error - #706

Merged
briceamen merged 4 commits into
masterfrom
fix/STORY-4495/generic_continuous_backup_error
Oct 16, 2026
Merged

briceamen merged 4 commits into
masterfrom
fix/STORY-4495/generic_continuous_backup_error

Conversation

@briceamen

@briceamen briceamen commented Oct 13, 2026 •

Copy link
Copy Markdown
Contributor

Documents the generic continuous backup contract: status is healthy for healthy events and unhealthy for delayed and stale events, and error is "Continuous backup is currently unavailable." or null. The pgBackRest/MyHoard statuses and error examples are gone.

Story: https://app.notion.com/p/3edf536d89bf80f38b4fe3e40c22a798
Related: Scalingo/api#3596, Scalingo/go-scalingo#536, Scalingo/dashboard-next#3127

@notion-workspace

Copy link
Copy Markdown

@briceamen
briceamen marked this pull request as ready for review October 15, 2026 15:03
@briceamen briceamen self-assigned this Oct 15, 2026
Comment thread _scalingo_api/events.md
{
"id": "682ee9400d6f86026b179c54",
"created_at": "2026-05-22T08:00:01.103Z",
"type": "database_continuousbackup_delayed",

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As stale and delayed are not in the status anymore, should we make them disappear everywhere from the examples as well ? As in the type here ?
As we do not show the delay anymore (12 or 24h) the number of examples may be reduced ?

@briceamen briceamen Oct 16, 2026 •

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

delayed and stale are still separate event types (users can subscribe to them separately), so they should stays in type . Since the status no longer says how late the backup is, the type is now what tells you if it's 12h or 24h.

I removed the MySQL example, which was the same as the PostgreSQL one, so there's one example per event type now.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok, thanks for the clarification, and cleaning.

@briceamen
briceamen merged commit 9f0fe2a into master Oct 16, 2026
3 checks passed
@briceamen
briceamen deleted the fix/STORY-4495/generic_continuous_backup_error branch October 16, 2026 08:19
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.

2 participants