安装| 配置| 资源展示| 贡献

jupyter 资源使用情况

Jupyter Resource Usage 是 Jupyter Notebooks 和 JupyterLab 的扩展，它显示当前笔记本服务器及其子节点（内核、终端等）正在使用多少资源。这显示在笔记本本身的主工具栏中，每 5 秒刷新一次。

安装

您当前可以从 PyPI 安装此软件包。

pip install jupyter-resource-usage

或与conda：

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

如果您的笔记本版本 < 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_percenttrait 以启用 CPU 使用跟踪（默认禁用）：

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

作为命令行参数：

jupyter notebook --ResourceUseDisplay.track_cpu_percent=True

禁用 Prometheus 指标

Prometheus 指标存在一个已知错误，会导致 UI 出现“滞后”/暂停。要解决此问题，您可以使用以下方法禁用 Prometheus 指标报告：

--ResourceUseDisplay.enable_prometheus_metrics=False

显示的资源

目前，服务器扩展仅报告内存使用情况（仅 RSS）和 CPU 使用情况。未来将根据需要添加其他指标。

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

贡献

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