Skip to main content

jupyterlab_resource_monitor_extension

GitHub Actions npm version PyPI version Total PyPI downloads JupyterLab 4 Brought To You By KOLOMOLO Donate PayPal

JupyterLab extension that replaces jupyter-resource-usage with a less intrusive and better implementation of resource usage monitoring.

This extension is composed of a Python package named jupyterlab_resource_monitor_extension for the server extension and a NPM package named @stellarshenson/jupyterlab-resource-monitor-extension for the frontend extension.

Features

  • Memory monitor in the status bar - current memory usage with the maximum available memory shown alongside; under cgroup v2 this is the server's own cgroup, and without it the reading is host-wide
  • CPU usage in the status bar - live CPU utilization next to the memory indicator, as a percentage, a compact bar, or a grid; same scope as the memory reading
  • Per-core grid - the grid mode draws the cores assigned to this server as a square of cells, each gaining opacity with its own load and burning brighter past 75%, so a few pinned cores and an evenly busy machine look different at the same percentage
  • Kernel usage panel - sidebar panel showing memory and CPU for the kernel attached to the notebook you are looking at
  • Container aware - reads the cgroup v2 limits when present, so the ceiling shown is the container's limit rather than the host's RAM
  • Event-loop safe metrics collection - metrics are gathered off the tornado event loop, so polling never blocks websockets, kernel messages, or static file serving
  • Bounded collection cost - no synchronous recursive walk of the server's child process tree, so a large or leaked process population cannot degrade JupyterLab responsiveness
  • Measures kernels only while you are watching - the kernel panel samples solely while it is open, and stops entirely when it is closed
  • Drop-in replacement - designed to replace jupyter-resource-usage with a safer implementation

How the collection stays off the event loop, what bounds its cost, and how it degrades is described in How Resource Collection Avoids Blocking the Server.

Settings

Configure under Settings -> Settings Editor -> Resource Monitor.

Setting Default Effect
showMemory true Show the memory item in the status bar
showCpu true Show the CPU item in the status bar
showMemoryPercent false Append the used-of-limit percentage to the memory item
cpuMode normalised normalised shares all cores (0-100%), aggregate sums each core's own 100%, bar draws a filled bar, grid draws the cores as a square
showKernelUsage true Show the kernel usage sidebar panel

Hovering either status bar item shows the full detail regardless of these settings, including the memory percentage and the CPU core count.

Requirements

  • JupyterLab >= 4.6.0
  • Linux host - the sampler reads cgroup v2 and /proc; on macOS and Windows no reading is available, so the status bar items stay hidden and the kernel panel reports Measuring...

Install

To install the extension, execute:

pip install jupyterlab_resource_monitor_extension

Uninstall

To remove the extension, execute:

pip uninstall jupyterlab_resource_monitor_extension

Metadata

Release files for jupyterlab-resource-monitor-extension 1.0.32

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for jupyterlab-resource-monitor-extension 1.0.32
File Size Uploaded Provenance Actions
jupyterlab_resource_monitor_extension-1.0.32.tar.gz 329.6 kB Without provenance Details for jupyterlab_resource_monitor_extension-1.0.32.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for jupyterlab-resource-monitor-extension 1.0.32
File Interpreter ABI Platform Actions
jupyterlab_resource_monitor_extension-1.0.32-py3-none-any.whl Python 3 none any Details for jupyterlab_resource_monitor_extension-1.0.32-py3-none-any.whl

Total release size: 399.9 kB

Release files / jupyterlab_resource_monitor_extension-1.0.32.tar.gz

Download URL jupyterlab_resource_monitor_extension-1.0.32.tar.gz
Size 329.6 kB
Tags Source
SHA-256 checksum
How to use checksums
cdd88f8520cab82c78ec9463e89dcf2fd92071d973b4541ee6a2ef57739aa0ec
BLAKE2b-256 checksum
How to use checksums
e4021fd9eadb6669b2899399531a440a231b1c366e6e60f27b460e49ac51081f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.14.10

Release files / jupyterlab_resource_monitor_extension-1.0.32-py3-none-any.whl

Download URL jupyterlab_resource_monitor_extension-1.0.32-py3-none-any.whl
Size 70.3 kB
Tags Python 3
SHA-256 checksum
How to use checksums
f8ef8403304228f2544987a861022d0c368896a546aa7ca81fde048dcc351f7c
BLAKE2b-256 checksum
How to use checksums
3fe7dc691cfe0d0b48781d6522c73429fbfbccce1eb0094a4467762f46223548
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.14.10

Security for jupyterlab-resource-monitor-extension 1.0.32

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page