Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
mcharytoniuk authored Dec 7, 2024
1 parent 01d9cb4 commit eaa2d84
Showing 1 changed file with 24 additions and 1 deletion.
25 changes: 24 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -158,7 +158,24 @@ https://github.com/distantmagic/paddler/assets/1286785/34b93e4c-0746-4eed-8be3-c

Although Paddler integrates with the [StatsD protocol](https://github.com/statsd/statsd), you can preview the cluster's state using a built-in dashboard.

![Paddler State Dashboard](https://github.com/user-attachments/assets/b12413ca-481b-4d49-9908-5dc38346305a)
#### Web Dashboard

Paddler needs to be compiled with the `web_dashboard` feature flag enabled (enabled by default in GitHub releases).

To start the dashboard, run `paddler balancer` with the `--management-dashboard-enable` flag.

![Paddler Web Dashboard](https://github.com/user-attachments/assets/b12413ca-481b-4d49-9908-5dc38346305a)

#### TUI Dashobard

> [!NOTE]
> Available since v1.2.0
You can connect to any running Paddler instance with `paddler dashboard --management-addr [HOST]:[PORT]`.

![Paddler TUI Dashboard](https://github.com/user-attachments/assets/55dc8cfe-4b82-4619-871f-0bb79cb44d01)

Thank you [@Propfend](https://github.com/Propfend) for [contributing](https://github.com/distantmagic/paddler/pull/31) the TUI Dashboard!

### StatsD Metrics

Expand Down Expand Up @@ -195,6 +212,12 @@ If you do not provide the `--statsd-addr` flag, the StatsD metrics will not be c

## Changelog

### v1.2.0

#### Features

- Add TUI dashboard (`paddler dashboard --management-addr [HOST]:[PORT]`) to be able to easily observe balancer instances from the terminal level

### v1.1.0

- More meaningful error messages when the agent can't connect to the llama.cpp slot endpoint, or when slot endpoint is not enabled in llama.cpp
Expand Down

0 comments on commit eaa2d84

Please sign in to comment.