Dokploy / Dokploy/dokploy

Implement heartbeat callback for database backups

Open
#1,927 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
TypeScript
Stars
37.4k
Forks
3k
Avg merge
1d 3h
Merged PRs (30d)
73

Description

What problem will this feature address?

Although we dokploy has notifications when a database backup succeeds or fails, it could be that dokploy's control panel is not working (and hence the backup does not run, and the notification is not sent!).

Describe the solution you'd like

In order to improve dokploy's observability, I think it would be very useful to allow to implement an 'onSuccess' callback for every database backup, that allows to configure either:

  • A script that is called once the backup succeeds
  • Calls an http endpoint

There are multiple uptime services that use the concept of a heartbeat: After an async operation succeeds, it's supposed to send a heartbeat (in the shape of a request to a specific URL). If the heartbeat is not received, then the uptime service would notify an admin to check what went wrong.

Describe alternatives you've considered
Additional context

No response

Will you send a PR to implement it?

No

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the database backup implementation and the existing success and failure notification paths. Define how a per-backup callback would be configured and triggered for a script or HTTP endpoint, then verify that a successful backup invokes it and that failures do not. No files or tests are identified in the issue.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
databases, observability
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.