Command line tool for monitoring slurm jobs on a linux system.
Project description
# Slurm Job Resource Monitor
A python command line tool to monitor the resources of your slurm jobs in form of a regularly updated table.
![Demo Image](https://github.com/tmachnitzki/slurm_job_resource_monitor/blob/main/demo.jpg)
## Installation
Install via pip:
`bash pip install slurm-job-resource-monitor `
## Usage
On a slurm managed cluster, run the following command to monitor your jobs:
`bash slurm_job_monitor `
To get all the possible options run:
`bash slurm_job_monitor --help `
The preferred way to use the tool is with the group-by-cmd option to not spam the table when running multi-cpu jobs:
`bash slurm_job_monitor --group-by-cmd "sum" `
## Assumptions / Preliminary
The tool assumes that:
you are running on a slurm managed cluster.
The tool assumes that you have a slurm account.
You can ssh in all allocated notes.
For ssh within the cluster no password is needed (only ssh key).
You need nvidia-smi to display GPU info of nodes (optional).
You can run “ps auxfww” to display CPU info of nodes.
## Some Further Info
Only processes are displayed that have a CPU load > 0.0 $ as shown by “ps auxfww”. This is to avoid the spamming of the table with processes that are not doing anything.
The table is grouped by jobs. So if one job runs on multiple GPUs and nodes they will all be displayed in the same “section” of row. Sections are separated by a horizontal line.
There is a minimal width that the terminal needs to have to display the table correctly. The only column that allows wrapping is the “Command” column.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file slurm-job-resource-monitor-2.7.1.tar.gz
.
File metadata
- Download URL: slurm-job-resource-monitor-2.7.1.tar.gz
- Upload date:
- Size: 114.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.9.16
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | ff0dd484d08f83ff96507a8fc2a3ce56fa88ce8a7e9754507f1acf11c8b9b287 |
|
MD5 | e2e94658a1a09aa39db0438c03eef9d8 |
|
BLAKE2b-256 | 6d43e6f73dfc5d7ab9242b917a70b2b8c612c7115935e17aff266e8055049c73 |
File details
Details for the file slurm_job_resource_monitor-2.7.1-py3-none-any.whl
.
File metadata
- Download URL: slurm_job_resource_monitor-2.7.1-py3-none-any.whl
- Upload date:
- Size: 9.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.9.16
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | e909f5fac314b4698751c283597596a223f72c46c1da8e5bb73354fc735eb4e5 |
|
MD5 | 3d928d21d16e9d85a657e9e9656c32ae |
|
BLAKE2b-256 | 50d3da8946e2de5a728ff07ae03cd920700bfb509d61a4c5fa7ce6b8b3518536 |