Skip to content

feat: Add database continuous backup events for healthy, delayed, and stale states #670

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

Draft
curzolapierre wants to merge 1 commit into
base: master
Choose a base branch
from
+150 −0
Draft

feat: Add database continuous backup events for healthy, delayed, and stale states #670

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
150 changes: 150 additions & 0 deletions _scalingo_api/events.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2045,6 +2045,156 @@ Example object:

--- row ---

* **Database Continuous Backup Healthy**

_When:_ Point-in-time recovery is available and restore points are up to date
`type=database_continuousbackup_healthy`

{:.table}
| field | type | description |
| ------------------------------- | -------- | ------------------------------------------------------------------ |
| addon_name | string | The related addon name |
| resource_id | string | The related addon resource ID |
| addon_uuid | string | The related addon UUID |
| category | string | The backup monitoring category |
| reason | string | The reason reported by the backup monitoring service |
| 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 |

**Note:** For notifications derived from this event, `author_name` defaults to `backup service`.

||| col |||

Example object:

```json
{
"id": "682ee9400d6f86026b179c53",
"created_at": "2026-05-22T08:00:01.103Z",
"type": "database_continuousbackup_healthy",
"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": "PostgreSQL",
"resource_id": "sample-go-martini-6184",
"addon_uuid": "ad-75364c08-2e76-4018-8db4-d7ebbd7537c8",
"category": "continuous-backup",
"reason": "restore points up to date",
"recoverable": true,
"checked_at": "2026-05-22T08:00:00.000Z",
"unrecoverable_duration_seconds": 0
}
}
```

--- row ---

* **Database Continuous Backup Delayed**

_When:_ The latest restorable point is more than 12 hours behind
`type=database_continuousbackup_delayed`

{:.table}
| field | type | description |
| ------------------------------- | -------- | ------------------------------------------------------------------ |
| addon_name | string | The related addon name |
| resource_id | string | The related addon resource ID |
| addon_uuid | string | The related addon UUID |
| category | string | The backup monitoring category |
| reason | string | The reason reported by the backup monitoring service |
| 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 |

**Note:** For notifications derived from this event, `author_name` defaults to `backup service`.

||| col |||

Example object:

```json
{
"id": "682ee9400d6f86026b179c54",
"created_at": "2026-05-22T08:00:01.103Z",
"type": "database_continuousbackup_delayed",
"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": "PostgreSQL",
"resource_id": "sample-go-martini-6184",
"addon_uuid": "ad-75364c08-2e76-4018-8db4-d7ebbd7537c8",
"category": "continuous-backup",
"reason": "restore point delayed",
"recoverable": false,
"checked_at": "2026-05-22T08:00:00.000Z",
"unrecoverable_duration_seconds": 43201
}
}
```

--- row ---

* **Database Continuous Backup Stale**

_When:_ The latest restorable point is more than 24 hours behind
`type=database_continuousbackup_stale`

{:.table}
| field | type | description |
| ------------------------------- | -------- | ------------------------------------------------------------------ |
| addon_name | string | The related addon name |
| resource_id | string | The related addon resource ID |
| addon_uuid | string | The related addon UUID |
| category | string | The backup monitoring category |
| reason | string | The reason reported by the backup monitoring service |
| 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 |

**Note:** For notifications derived from this event, `author_name` defaults to `backup service`.

||| col |||

Example object:

```json
{
"id": "682ee9400d6f86026b179c55",
"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": "PostgreSQL",
"resource_id": "sample-go-martini-6184",
"addon_uuid": "ad-75364c08-2e76-4018-8db4-d7ebbd7537c8",
"category": "continuous-backup",
"reason": "restore point stale",
"recoverable": false,
"checked_at": "2026-05-22T08:00:00.000Z",
"unrecoverable_duration_seconds": 86401
}
}
```

--- row ---

* **New Project Created**

_When:_ A new project has been created
Expand Down