Jupyter Notebook Extension for monitoring your own Resource Usage
Branch: master
Clone or download
yuvipanda Merge pull request #9 from yuvipanda/auto-install
Automatically install & enable extensions
Latest commit 9ff7d3f Aug 3, 2018
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
nbresuse Put nbextension / serverextension enables in different places Aug 3, 2018
.gitignore
CONTRIBUTING.md Add CONTRIBUTING.md doc Apr 1, 2018
LICENSE Initial commit Apr 22, 2016
README.md
screenshot.png Lots of new features + v0.2 bump! Apr 1, 2018
setup.py
warn-screenshot.png Lots of new features + v0.2 bump! Apr 1, 2018

README.md

nbresuse

Screenshot with memory limit

NB Resource Usage (nbresuse) is a small extension for Jupyter Notebooks that displays an indication of how much resources your current notebook server and its children (kernels, terminals, etc) are using. This is displayed in the main toolbar in the notebook itself, refreshing every 5s.

Installation

You can currently install this package from PyPI.

pip install nbresuse

If your notebook version is < 5.3, you need to enable the extension manually.

jupyter serverextension enable --py nbresuse --sys-prefix
jupyter nbextension install --py nbresuse --sys-prefix
jupyter nbextension enable --py nbresuse --sys-prefix

Configuration

Memory Limit

nbresuse can display a memory limit (but not enforce it). You can set this in serveral ways:

  1. MEM_LIMIT environment variable. This is set by JupyterHub if using a spawner that supports it.
  2. In the commandline when starting jupyter notebook, as --ResourceUseDisplay.mem_limit.
  3. In your jupyter notebook traitlets config file

The limit needs to be set as an integer in Bytes.

Memory usage warning threshold

Screenshot with memory warning

The background of the resource display can be changed to red when the user is near a memory limit. The threshold for this warning can be configured as a fraction of the memory limit.

If you want to flash the warning to the user when they are within 10% of the memory limit, you can set the parameter --ResourceUseDisplay.mem_warning_threshold=0.1.

Resources displayed

Currently it only displays Memory usage (just RSS). Other metrics will be added in the future as needed.