From db4d42e1cc65a418add1fdfc5310b4b87945806a Mon Sep 17 00:00:00 2001 From: Brice Amen Date: Tue, 13 Oct 2026 16:31:14 +0200 Subject: [PATCH 1/4] feat(events) [STORY-4495] document the generic continuous backup status and error --- .../database_continuousbackup_type_data_table.md | 4 ++-- _scalingo_api/events.md | 12 ++++++------ 2 files changed, 8 insertions(+), 8 deletions(-) diff --git a/_includes/scalingo_api/events/database_continuousbackup_type_data_table.md b/_includes/scalingo_api/events/database_continuousbackup_type_data_table.md index 0668a18..69bab2d 100644 --- a/_includes/scalingo_api/events/database_continuousbackup_type_data_table.md +++ b/_includes/scalingo_api/events/database_continuousbackup_type_data_table.md @@ -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. Possible values: `healthy` (when `recoverable` is `true`) and `unhealthy` | +| 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 | diff --git a/_scalingo_api/events.md b/_scalingo_api/events.md index 5435883..ca137a4 100644 --- a/_scalingo_api/events.md +++ b/_scalingo_api/events.md @@ -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 @@ -2190,8 +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", + "status": "unhealthy", + "error": "Continuous backup is currently unavailable.", "recoverable": false, "checked_at": "2026-05-22T08:00:00.000Z", "unrecoverable_duration_seconds": 86401 @@ -2217,8 +2217,8 @@ Example object for a MySQL database: "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 From 60b10868e3d11d211b739df55d8d0bd8b87586a1 Mon Sep 17 00:00:00 2001 From: Brice Amen Date: Tue, 13 Oct 2026 16:31:55 +0200 Subject: [PATCH 2/4] feat(events) [STORY-4495] document unrecoverable healthy events --- _scalingo_api/events.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/_scalingo_api/events.md b/_scalingo_api/events.md index ca137a4..0270ebe 100644 --- a/_scalingo_api/events.md +++ b/_scalingo_api/events.md @@ -2089,7 +2089,7 @@ Example object: * **Database Continuous Backup Healthy** -_When:_ Point-in-time recovery is available and restore points are up to date +_When:_ Point-in-time recovery is available and restore points are up to date, or recovery was lost less than 12 hours ago (in that case `recoverable` is `false` and `status` is `unhealthy`) `type=database_continuousbackup_healthy` {% include scalingo_api/events/database_continuousbackup_type_data_table.md %} From 9213bd3af919077d1571d5dfa16746637a5286dd Mon Sep 17 00:00:00 2001 From: Brice Amen Date: Wed, 14 Oct 2026 17:15:18 +0200 Subject: [PATCH 3/4] feat(events) [STORY-4495] continuous backup status depends on the event type --- .../events/database_continuousbackup_type_data_table.md | 2 +- _scalingo_api/events.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/_includes/scalingo_api/events/database_continuousbackup_type_data_table.md b/_includes/scalingo_api/events/database_continuousbackup_type_data_table.md index 69bab2d..5588984 100644 --- a/_includes/scalingo_api/events/database_continuousbackup_type_data_table.md +++ b/_includes/scalingo_api/events/database_continuousbackup_type_data_table.md @@ -4,7 +4,7 @@ | 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` (when `recoverable` is `true`) and `unhealthy` | +| 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 | diff --git a/_scalingo_api/events.md b/_scalingo_api/events.md index 0270ebe..ca137a4 100644 --- a/_scalingo_api/events.md +++ b/_scalingo_api/events.md @@ -2089,7 +2089,7 @@ Example object: * **Database Continuous Backup Healthy** -_When:_ Point-in-time recovery is available and restore points are up to date, or recovery was lost less than 12 hours ago (in that case `recoverable` is `false` and `status` is `unhealthy`) +_When:_ Point-in-time recovery is available and restore points are up to date `type=database_continuousbackup_healthy` {% include scalingo_api/events/database_continuousbackup_type_data_table.md %} From 9ecd6c5442a6883448cacc163f366ddf4aec56b2 Mon Sep 17 00:00:00 2001 From: Brice Amen Date: Fri, 16 Oct 2026 09:20:52 +0200 Subject: [PATCH 4/4] feat(events) [STORY-4495] drop redundant MySQL continuous backup example --- _scalingo_api/events.md | 27 --------------------------- 1 file changed, 27 deletions(-) diff --git a/_scalingo_api/events.md b/_scalingo_api/events.md index ca137a4..a4c69cf 100644 --- a/_scalingo_api/events.md +++ b/_scalingo_api/events.md @@ -2199,33 +2199,6 @@ Example object: } ``` -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": "unhealthy", - "error": "Continuous backup is currently unavailable.", - "recoverable": false, - "checked_at": "2026-05-22T08:00:00.000Z", - "unrecoverable_duration_seconds": 86401 - } -} -``` - --- row --- * **New Project Created**