Skip to content

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

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
briceamen merged 4 commits into from
Oct 16, 2026
Merged

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

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
db4d42e
feat(events) [STORY-4495] document the generic continuous backup stat…
briceamen Oct 13, 2026
60b1086
feat(events) [STORY-4495] document unrecoverable healthy events
briceamen Oct 13, 2026
9213bd3
feat(events) [STORY-4495] continuous backup status depends on the eve…
briceamen Oct 14, 2026
9ecd6c5
feat(events) [STORY-4495] drop redundant MySQL continuous backup example
briceamen Oct 16, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions _includes/scalingo_api/events/database_continuousbackup_type_data_table.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@
| addon_name | string | The related addon name |
| resource_id | string | The related addon resource ID |
| addon_uuid | string | The related addon UUID |
| status | string | Continuous backup status. Possible values: `healthy`, `pgbackrest_error` and `wal_error` (PostgreSQL), `myhoard_error` (MySQL) |
| error | string or null | Error message returned by the continuous backup checker |
| status | string | Continuous backup status: `healthy` for `database_continuousbackup_healthy` events, `unhealthy` for delayed and stale events |
| error | string or null | `Continuous backup is currently unavailable.` when the status is `unhealthy`, `null` otherwise |
| recoverable | boolean | Whether point-in-time recovery is currently available |
| checked_at | datetime | The date and time when the continuous backup status was checked |
| unrecoverable_duration_seconds | integer | Seconds elapsed since the resource last became unrecoverable |
35 changes: 4 additions & 31 deletions _scalingo_api/events.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2152,8 +2152,8 @@ Example object:
"addon_name": "PostgreSQL",
"resource_id": "sample-go-martini-6184",
"addon_uuid": "ad-b48f347e-2e3d-4b48-8dee-40eed0539ee1",
"status": "pgbackrest_error",
"error": "pgBackRest archive-push has been failing for 12h",
"status": "unhealthy",
"error": "Continuous backup is currently unavailable.",
"recoverable": false,
"checked_at": "2026-05-22T08:00:00.000Z",
"unrecoverable_duration_seconds": 43201
Expand Down Expand Up @@ -2190,35 +2190,8 @@ Example object:
"addon_name": "PostgreSQL",
"resource_id": "sample-go-martini-6184",
"addon_uuid": "ad-b48f347e-2e3d-4b48-8dee-40eed0539ee1",
"status": "wal_error",
"error": "WAL archiving has been stale for more than 24h",
"recoverable": false,
"checked_at": "2026-05-22T08:00:00.000Z",
"unrecoverable_duration_seconds": 86401
}
}
```

Example object for a MySQL database:

```json
{
"id": "682ee9400d6f86026b179c56",
"created_at": "2026-05-22T08:00:01.103Z",
"type": "database_continuousbackup_stale",
"app_id": "649e9d0389bca600016ea61b",
"app_name": "sample-go-martini",
"user": {
"username": "scalingo-platform",
"email": "deploy@scalingo.com",
"id": "us-b32ca09d-1608-4e6f-8f14-302b447b0e14"
},
"type_data": {
"addon_name": "MySQL",
"resource_id": "sample-go-martini-7291",
"addon_uuid": "ad-9f2c6e1a-4b7d-4e3a-8c5f-1d2e3f4a5b6c",
"status": "myhoard_error",
"error": "MyHoard reports no completed non-broken backup",
"status": "unhealthy",
"error": "Continuous backup is currently unavailable.",
"recoverable": false,
"checked_at": "2026-05-22T08:00:00.000Z",
"unrecoverable_duration_seconds": 86401
Expand Down