CHANGELOG.md

Changelog

1.1.0

(Full Changelog)

Enhancements made

• Add disk monitoring #233 (@iandesj)

Bugs fixed

• Remove spurious close button on kernel usage panel #228 (@krassowski)

Contributors to this release

(GitHub contributors page for this release)

@iandesj | @krassowski | @welcome

1.0.2

(Full Changelog)

Maintenance and upkeep improvements

• Update Release Scripts #230 (@blink1073)

Contributors to this release

(GitHub contributors page for this release)

@blink1073 | @pre-commit-ci

1.0.1

(Full Changelog)

Enhancements made

• Adds custom config to show/hide host usage info #210 (@pinksi)

Maintenance and upkeep improvements

• Add Notebook 7 to Binder #208 (@jtpio)

Contributors to this release

(GitHub contributors page for this release)

@jtpio | @pinksi | @welcome | @yuvipanda

1.0.0

(Full Changelog)

Enhancements made

• Integrate jupyterlab-system-monitor extension #202 (@mahendrapaipuri)

Bugs fixed

• Handle currentWidget in KernelWidgetTracker #206 (@jtpio)
• Stop all channels to allow ZMQContext to properly cleanup between calls #183 (@Zsailer)

Maintenance and upkeep improvements

• Make IStatusBar optional for resourceStatusPlugin #207 (@mahendrapaipuri)
• Require Python 3.8+ #201 (@jtpio)
• Bump word-wrap from 1.2.3 to 1.2.4 #200 (@dependabot)
• Bump semver from 5.7.1 to 5.7.2 #198 (@dependabot)
• Update to Jupyterlab 4 #195 (@jtpio)
• chore: move prettier and eslint configuration under package.json #188 (@SauravMaheshkar)
• Bump webpack from 5.75.0 to 5.76.1 #184 (@dependabot)
• Rename references from master to main #179 (@jtpio)

Documentation improvements

• Update README and fix settings file #205 (@mahendrapaipuri)

Contributors to this release

(GitHub contributors page for this release)

@dependabot | @jtpio | @mahendrapaipuri | @pre-commit-ci | @SauravMaheshkar | @welcome | @Zsailer

0.7.2

(Full Changelog)

Bugs fixed

• Clear state when switching away, add blank state indicator #178 (@krassowski)
• async fixes in kernel usage handler #177 (@minrk)

Maintenance and upkeep improvements

Contributors to this release

(GitHub contributors page for this release)

@Gsbreddy | @jtpio | @krassowski | @minrk | @pre-commit-ci | @welcome

0.7.1

(Full Changelog)

Enhancements made

• Use pss if available #171 (@jtpio)

Maintenance and upkeep improvements

• Fix formatting #174 (@jtpio)
• Bump http-cache-semantics from 4.1.0 to 4.1.1 #173 (@dependabot)
• Migrate to hatch #168 (@jtpio)
• Bump json5 from 1.0.1 to 1.0.2 #166 (@dependabot)

Contributors to this release

(GitHub contributors page for this release)

@dependabot | @jtpio

0.7.0

(Full Changelog)

Enhancements made

• Add support for kernel usage #164 (@davidbrochart)

Maintenance and upkeep improvements

• Bump loader-utils from 1.4.1 to 1.4.2 #158 (@dependabot)

Contributors to this release

(GitHub contributors page for this release)

@davidbrochart | @dependabot | @jtpio | @krassowski | @pre-commit-ci | @welcome

0.6.4

(Full Changelog)

Maintenance and upkeep improvements

• Bump loader-utils from 1.4.0 to 1.4.1 #157 (@dependabot)
• Prep for releaser v2 #154 (@blink1073)

Contributors to this release

(GitHub contributors page for this release)

@blink1073 | @dependabot | @pre-commit-ci | @welcome

0.6.3

(Full Changelog)

Bugs fixed

• Define _jupyter_server_extension_paths for backward compatibility #148 (@casparvl)
• Fix update at zero cpu #147 (@casparvl)

Maintenance and upkeep improvements

• Remove prepare script #145 (@jtpio)
• Bump terser from 5.10.0 to 5.15.0 #141 (@dependabot)
• Bump moment from 2.29.2 to 2.29.4 #140 (@dependabot)

Contributors to this release

(GitHub contributors page for this release)

@casparvl | @dependabot | @jtpio | @pre-commit-ci | @welcome

0.6.2

(Full Changelog)

Enhancements made

• Allow users to opt out of prometheus metrics #124 (@dleen)

Maintenance and upkeep improvements

• Fix lint configuration and failures #138 (@kevin-bates)
• [pre-commit.ci] pre-commit autoupdate #137 (@pre-commit-ci)
• [pre-commit.ci] pre-commit autoupdate #135 (@pre-commit-ci)
• Bump parse-url from 6.0.0 to 6.0.2 #133 (@dependabot)
• [pre-commit.ci] pre-commit autoupdate #132 (@pre-commit-ci)
• [pre-commit.ci] pre-commit autoupdate #131 (@pre-commit-ci)
• [pre-commit.ci] pre-commit autoupdate #129 (@pre-commit-ci)
• Bump nanoid from 3.1.30 to 3.3.3 #128 (@dependabot)
• [pre-commit.ci] pre-commit autoupdate #126 (@pre-commit-ci)
• Bump moment from 2.29.1 to 2.29.2 #125 (@dependabot)
• [pre-commit.ci] pre-commit autoupdate #122 (@pre-commit-ci)
• Bump minimist from 1.2.5 to 1.2.6 #121 (@dependabot)
• Bump url-parse from 1.5.3 to 1.5.10 #120 (@dependabot)

Documentation improvements

• Point the Binder link to the default branch #117 (@jtpio)

Contributors to this release

(GitHub contributors page for this release)

@dependabot | @dleen | @jtpio | @kevin-bates | @pre-commit-ci | @welcome

0.6.1

(Full Changelog)

Enhancements made

• catch psutil exceptions #113 (@jhgoebbert)
• Add CPU display to extension #105 (@stevenstetzler)

Bugs fixed

• Ensure we use backoff when request fails #104 (@vidartf)

Maintenance and upkeep improvements

• Adopt the Jupyter Releaser, update Jupyter Packaging #115 (@jtpio)

Other merged PRs

• Bump tar from 6.1.5 to 6.1.11 in /packages/labextension #111 (@dependabot)
• Bump url-parse from 1.5.1 to 1.5.3 in /packages/labextension #110 (@dependabot)
• Bump path-parse from 1.0.6 to 1.0.7 in /packages/labextension #108 (@dependabot)
• Bump tar from 6.1.0 to 6.1.5 in /packages/labextension #106 (@dependabot)
• Bump normalize-url from 4.5.0 to 4.5.1 in /packages/labextension #103 (@dependabot)
• Bump ws from 7.4.5 to 7.4.6 in /packages/labextension #102 (@dependabot)
• Update to 3.0.16 packages #101 (@jtpio)
• Update dependencies #100 (@jtpio)
• Bump lodash from 4.17.20 to 4.17.21 in /packages/labextension #99 (@dependabot)
• Bump hosted-git-info from 2.8.8 to 2.8.9 in /packages/labextension #98 (@dependabot)
• Add changelog for 0.6.0 #96 (@jtpio)

Contributors to this release

(GitHub contributors page for this release)

@dependabot | @jhgoebbert | @jtpio | @stevenstetzler | @vidartf | @welcome

0.6.0

• executor as ApiHandle class attribute #95 (jtpio)
• Update RELEASE.md #94 (jtpio)
• Clarify notebook/jupyter_server usage #93 (fcollonval)
• Bump ssri from 8.0.0 to 8.0.1 in /packages/labextension #90 (dependabot[bot])
• Update to JupyterLab 3.0 final packages #87 (jtpio)
• Add instructions to install with conda #83 (jtpio)
• Add Changelog for 0.5.1 #82 (jtpio)

0.5.1

• Skip building js assets if they already exist: #81

0.5.0

The repository has now moved to the jupyter-server organization on GitHub.

It was also renamed to jupyter-resource-usage.

To install the package with pip:

pip install jupyter-resource-usage

Other changes

• Add a JupyterLab extension for the memory usage status bar item: #69
• Drop the deprecated /metrics endpoint: #77

Migrating to 0.5.0

For classic notebook users, there shouldn't be any major change or action to take. The classic notebook extension is still distributed with the Python package as before.

For JupyterLab 2.x users you will still need to use the previous nbresuse package. See below for more information.

For JupyterLab 3.x, the status bar item is now packaged in its own extension and distributed with the jupyter-resource-usage package. This means that a single pip install jupyter-resource-usage is enough to install the server extension, the classic notebook extension and the JupyterLab extension all at once.

0.4.0

• Soft-deprecate /metrics endpoint: #68
• nbresuse now exposes a new endpoint: /api/metrics/v1: #68

Migrating to 0.4.0

To upgrade to the latest version:

python -m pip install -U nbresuse

If you use the classic notebook, there shouldn't be anything to do. The classic notebook extension already uses the new endpoint and is automatically installed.

If you use JupyterLab 2.x and want the memory usage indicator in the status bar to continue showing metrics:

Two options:

• continue using nbresuse==0.3.6 instead of 0.4.0
• enable the deprecated /metrics endpoint with:

jupyter lab --ResourceUseDisplay.disable_legacy_endpoint=False

0.3.6

• Fix handling of cpu percent in the API endpoint #56
• Added Binder #53 & RELEASE.md #54

0.3.5

• Adding support for jupyterlab statusbar-extension #45 #36

Note: this release restores the /metrics endpoint returning a JSON response, that was removed in 0.3.4.

0.3.4

• Autoformatting and documentation #33
• Add section about CPU usage to the README #30
• Make psutil optional dependency of NBResuse #25
• Report the memory usage metrics as prometheus metrics #22

Note: this release removed the /metrics endpoint that was returning a JSON response. As a result, JupyterLab does not display the memory usage indicator in the status bar with nbresuse==0.3.4.

0.3.3

• Made memory limit possibly dynamic via passing a callable in the config. #23
• Track CPU usage #21

0.3.2

• Require authentication for /metrics API Handler #18

0.3.1

• Don't poll in background, since user does not see it #15
• Poll instantly once page is foregrounded #15

This should reduce the number of /metrics requests massively, with minimal interruption to user experience.

0.3.0

• Automatically install & enable extensions #9
• Put nbextension / serverextension enables in different places
• Put nbresuse js files in appropriate path

0.2.0

• Change 'Mem' prefix in display to less cryptic 'Memory'
• Fix primary screenshot to show memory limit too
• Distribute static files via package_data #1
• Add screenshot for memory usage warning
• Configurable memory usage warnings
• More configurability via traitlets
• Consolidate code into single file
• Document memory limit behavior
• Add CONTRIBUTING.md doc
• Updated README

0.1.0

• Initial Commits for memory usage display