Skip to content

feat: add healthchecks section to self host #29

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.

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
merged 4 commits into from
Nov 12, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
1 change: 1 addition & 0 deletions mint.json
Original file line number Diff line number Diff line change
Expand Up @@ -353,6 +353,7 @@
"self-hosting/lifecycle-maintenance",
"self-hosting/lifecycle-maintenance/securing-your-deployment",
"self-hosting/lifecycle-maintenance/server-specs",
"self-hosting/lifecycle-maintenance/healthchecks",
"self-hosting/lifecycle-maintenance/telemetry"
]
},
Expand Down
29 changes: 29 additions & 0 deletions self-hosting/lifecycle-maintenance/healthchecks.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
---
title: "Healthchecks"
---

<Info>
This requires the Docker image to be `journeyapps/powersync-service:0.5.8` or later.
</Info>

The following endpoints can be used to check your system:

### Startup:

You can use the `/probes/startup` endpoint to confirm the service has started up correctly.

A `200` status code shows the system has started up.

A `400` status code shows the system has **not** yet started.

### Liveness:

You can use the `/probes/liveness` endpoint to confirm the service is alive.

A `200` status code shows the system is alive.

A `400` status code shows the system is **not** alive.

<Tip>
**Example**: An example configuration with Docker Compose is available in the [self-host-demo app](https://github.com/powersync-ja/self-host-demo/blob/main/services/powersync.yaml).
</Tip>