Check Server Resources (CSR) - Minimalist Version

A minimalist and private webpage to monitor resources on local "GPU servers". Only YOU and the people in your network can access the webpage displaying your server resources.

What do I get from miniCSR?
Statistics of your GPU, CPU and disk space ressources for each server in one place. Here is how it looks like (Anonymized Screen Shoot):

How does it actually work?
TODO

Setting up miniCSR

Clone the project

Run the following on your local machine that is doing the monitoring:

git clone https://github.com/Vujas-Eteph/miniCSR
mamba env create -f environment.yml  # [TODO: Add the correct environment file name] # You can also use conda instead of mamba

Note

We don't need to install anything on the servers that we are going to monitor, since we only rely on basic linux commands that should already be available natively.

Configuration of the servers to acess with miniCSR

When setting up ssh connections, natively linux will save it in .ssh/config, which you can modify like below

# .ssh/config template
Host SERVER_ALIAS
    HostName SERVER_IP  # Replace with actual server IP
    User USER_NAME      # Replace with actual user name
    IdentityFile ~/.ssh/id_rsa
    Port XX             # Replace with the actual port number
    UserKnownHostsFile ~/.ssh/known_hosts

Afterwards, add the SERVER_ALIAS of the servers you want to monitor inside server_names.yaml like in this example. Hence, miniCSR is only accesssing those that you want to monitor and not all the servers you have ssh access too.

Running miniCSR

• Run the following commands in TMUX:

  tmux new-session CSR
  mamba activate miniCSR
  bash ./start_CSR.sh

Note

By default, the webpage is on your local port 1990. You can change that in the configurations.

• When debugging:

  mamba activate miniCSR
  python3 monitoring.py -r RRRR(sec) -s SSSS(sec)  # start the monitoring script in one terminal
  gunicorn -w 4 -b 0.0.0.0:1990 app:app  # start the Gunicorn server in another terminal

Warning

This project has been tested on an Ubuntu distributions and uses Python 3. We mostly rely on basic linux commands to get the internal state of the servers and process it with Python.

---

Motivation for the project

The Origin Story

Before CSR, I had to manually check if a server was available by SSHing into each server one by one. This process became cumbersome already at the second attempt.
So to save time, I wanted a centralized monitoring tool that consolidates this task, making it quick and efficient. Hence, this project.

Long-Term Vision

The project is planned to be expanded to include additional features, such as:

• A calendar for optimizing resource usage and scheduling.
• Advanced visualization tools to monitor trends over time.

Future Features

• Add graphs or curves to visualize the server load over time.
• Add a calendar section for you and your coworkers to reserve "training slots".
• Add a license to restrict commercial use of the project.