Skip to content

change healthcheck img #61 #62

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
akyriako merged 1 commit into from
May 19, 2026
Merged

change healthcheck img #61 #62

Show file tree
Hide file tree
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
5 changes: 2 additions & 3 deletions docs/healthcheck.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -103,16 +103,15 @@ You can configure external load balancers (e.g., AWS ALB or Open Telekom Cloud E

## Web UI

The library ships with an interactive, single-page monitoring UI built on Vue.js and Vuetify. Its design and layout are inspired by the
[podinfo](https://github.com/stefanprodan/podinfo) demo landing page. It provides:
The library ships with an interactive, single-page monitoring UI built on Vue.js and Vuetify. It provides:

* **Instant overview**: a clean dashboard that lists every node in your Typesense `StatefulSet`, showing key metrics (leader/follower/candidate state, committed index, queued writes) at a glance.
* **Auto-refresh**: the UI polls the `/readyz` endpoint every 3 seconds, ensuring you always see up-to-date cluster health without manual reloads.
* **Color-coded status**: each node’s health is highlighted with color-blind-friendly colors (light-green for healthy, pink for unhealthy), so you can spot issues immediately.
* **Responsive layout**: cards adapt across desktop and mobile, with Vuetify’s grid system ensuring your cluster view stays usable on any screen size.
* **Lightweight and self-contained**: extremely small memory footprint; just point your browser at `http://POD_IP_ADDRESS_OR_FQDN:HEALTHCHECK_PORT/` and dive right in.

![image1](/img/454372794-42db73c4-f175-4fb5-a862-ec83ace6ada7.png)
![image1](/img/Screenshot_from_2026-05-19_12-40-30.png)


## Configuration
Expand Down
Binary file added static/img/Screenshot_from_2026-05-19_12-40-30.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading