安装 | 配置 | 显示的资源 | 贡献

jupyter-resource-usage

Jupyter Resource Usage 是一个为 Jupyter Notebooks 和 JupyterLab 定制的扩展，它可以显示当前笔记本服务器及其子项（内核、终端等）所使用的资源量。这将在 JupyterLab 和笔记本的状态栏中显示，每 5 秒刷新一次。

使用 ipykernel >= 6.11.0 的 IPython 内核可以在侧边栏中显示内核资源使用情况。

对于 Notebook 7.x，内核使用情况也是可用的，可以在 查看 -> 右侧边栏 -> 显示内核使用情况 中启用。在 JupyterLab 界面中，只需点击右侧边栏上的 速度计 图标即可。

该软件包为 jupyter-resource-usage 指标提供了一个替代前端

以前，此扩展与 jupyterlab-system-monitor 软件包一起分发。从 1.0.0 版本开始，替代前端已集成到当前存储库中。有关如何启用和配置此替代前端的信息，请参阅替代前端部分。

注意，对于 JupyterLab 3.x 和 2.x，用户应从 jupyterlab-system-monitor 安装替代前端。

安装

JupyterLab 4.x 和 Notebook 7.x

您应安装最新版本 >=1.0.0 以确保与 JupyterLab 4 兼容。

pip install jupyter-resource-usage

或使用 conda

conda install -c conda-forge jupyter-resource-usage

JupyterLab 3.x 和 Notebook 6.x

您应将版本锁定为 <1.0.0

pip install 'jupyter-resource-usage<1.0.0'

或使用 conda

conda install -c conda-forge 'jupyter-resource-usage<1.0.0'

如果您的笔记本版本小于 5.3，则需要手动启用扩展。

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

配置

内存限制

jupyter-resource-usage 可以显示内存限制（但不会强制执行）。您可以通过以下几种方式设置此限制

1. MEM_LIMIT 环境变量。如果使用支持该功能的启动器，则由 JupyterHub 设置。
2. 在启动 jupyter notebook 命令时，作为 --ResourceUseDisplay.mem_limit。
3. 在您的 Jupyter notebook traitlets 配置文件中

限制需要以字节为单位的整数设置。

内存使用警告阈值

当用户接近内存限制时，资源显示的背景可以变为红色。此警告的阈值可以配置为内存限制的分数。

如果您想当用户在内存限制的 10% 以内时闪烁警告，可以设置参数 --ResourceUseDisplay.mem_warning_threshold=0.1。

CPU 使用率

jupyter-resource-usage 还可以跟踪 CPU 使用情况，并将 cpu_percent 值作为 /api/metrics/v1 响应的一部分报告。

您可以通过以下几种方式设置 cpu_limit

1. CPU_LIMIT 环境变量。如果使用支持该功能的启动器，则由 JupyterHub 设置。
2. 在启动 jupyter notebook 命令时，作为 --ResourceUseDisplay.cpu_limit。
3. 在您的 Jupyter notebook traitlets 配置文件中

限制对应于用户可访问的 CPU 数量，但不会强制执行。

此外，您还可以设置 track_cpu_percent 特性以启用 CPU 使用率跟踪（默认禁用）

c = get_config()
c.ResourceUseDisplay.track_cpu_percent = True

作为命令行参数

jupyter notebook --ResourceUseDisplay.track_cpu_percent=True

当 track_cpu_percent 设置为 True 时，状态将报告 CPU 利用率以及内存

磁盘[分区]使用情况

jupyter-resource-usage 还可以跟踪（已定义分区的）磁盘使用情况，并在 /api/metrics/v1 响应中报告 total 和 used 值。

通过设置 track_disk_usage 属性来启用跟踪（默认禁用）

c = get_config()
c.ResourceUseDisplay.track_disk_usage = True

这些值来自属性 disk_path（默认为 /home/joyvan）中包含文件夹的分区。如果此路径不存在，则不会显示磁盘使用信息。

与 CPU 和内存镜像一样，属性 disk_warning_threshold 表示何时标记使用警告，并且与其他属性一样，默认为 0.1（剩余 10%）

禁用 Prometheus 指标

存在一个关于 Prometheus 指标的已知问题，该问题会导致 UI 中的“延迟”/暂停。为了解决这个问题，您可以使用以下方法禁用 Prometheus 指标报告：

--ResourceUseDisplay.enable_prometheus_metrics=False

启用替代前端

默认情况下，替代前端是禁用的。要启用它，用户应转到 设置 -> 设置编辑器 -> 资源使用指示器，这将渲染以下表单

通过勾选“启用资源使用指示器”并刷新浏览器标签页，将在顶部栏中渲染替代前端。

用户可以使用设置编辑器更改替代前端的标签和刷新速率。

（默认包含垂直条，以帮助区分三个指示器。）

显示的资源

目前服务器扩展报告磁盘使用、内存使用和 CPU 使用。根据需要，将来将添加其他指标。

如果可能，内存使用将显示 PSS（仅限 Linux 功能），否则默认为 RSS。

笔记本扩展当前不显示 CPU 使用，只显示内存使用。

贡献

如果您想为该项目做出贡献，请阅读 CONTRIBUTING.md 文件。该文件解释了如何设置开发安装和如何运行测试套件。