Skip to content

docs: add monitoring metrics suggestions #558

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

Open
TheSomsie wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: add monitoring metrics suggestions #558

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
13 changes: 13 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -248,7 +248,20 @@ Therefore, you should do these actions in the following scenarios

- **Signed up with `email address`, generated `swarm.pem`, BUT lost `swarm.pem`** OR **You want to run multiple nodes at once**: run from scratch with the same email address and generate a new `swarm.pem`.
- **Signed up with `email address`, generated `swarm.pem`, kept `swarm.pem`** -> you can re-run a single node using this pair if you've still got them both.
## Monitoring metrics

RL Swarm exposes basic metrics (CPU, GPU and job status) that can be scraped and visualized by external tools.

Typical ways to monitor your node include:

* Exporting metrics to Prometheus and building dashboards in Grafana.
* Shipping logs (stdout/stderr) to a centralized log store (e.g. Loki, Elastic, or any log aggregation).

We recommend keeping an eye on:
* Training job failures per hour.
* Average GPU utilization.
* Disk usage in the directory storing checkpoints.

## Troubleshooting

- **How do I find my logs?** You can find them inside the `/logs` directory:
Expand Down