Jupyter资源使用监控扩展安装与使用指南

Jupyter资源使用监控扩展安装与使用指南

jupyter-resource-usage Jupyter Notebook Extension for monitoring your own Resource Usage 项目地址: https://gitcode.com/gh_mirrors/ju/jupyter-resource-usage

1. 目录结构及介绍

该项目位于GitHub，其主要的目录结构布局旨在支持Jupyter Notebook和JupyterLab环境中的资源监控功能。以下是关键组件的简介：

• jupyter_resource_usage : 核心模块，实现资源使用的数据收集与处理逻辑。
• packages/labextension : JupyterLab扩展相关代码，负责前端显示。
• doc : 文档资料，可能包括用户手册或开发指南。
• jupyter-config : 配置示例或说明，用于指导如何进行Jupyter的个性化配置。
• setup.py, pyproject.toml, install.json : 项目构建、依赖管理和安装脚本。
• tests : 自动化测试套件，确保代码质量。

2. 项目的启动文件介绍

项目本身不直接提供一个“启动文件”，因为它的集成是通过Jupyter的服务器扩展和Notebook扩展来完成的。安装并启用此扩展后，无需单独启动文件，Jupyter Notebook或JupyterLab在启动时会自动加载此扩展的功能。要启动带有资源监控功能的Jupyter Notebook或JupyterLab，您只需像平常一样运行命令，例如：

jupyter notebook

或对于JupyterLab:

jupyter lab

若需手动管理，可以通过以下命令来控制服务端扩展的状态：

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

以及对应地，若要禁用它：

jupyter serverextension disable --py jupyter_resource_usage --sys-prefix

3. 项目的配置文件介绍

全局配置

Jupyter的资源使用显示可配置项通常通过环境变量或者Jupyter的配置文件（如jupyter_notebook_config.py）来设定。例如，设置内存限制可以通过设置环境变量MEM_LIMIT，或者在配置文件中添加类似如下代码：

c.ResourceUseDisplay.mem_limit = 1073741824  # 设置为1GB作为例子

特殊配置选项

• 内存警告阈值：通过mem_warning_threshold可以定义当接近内存限制时的警告触发点。
• 显示主机信息：使用show_host_usage=True|False来决定是否在侧边栏展示主机CPU和虚拟内存信息。
• CPU跟踪与限制：配置cpu_limit和track_cpu_percent=True以启用CPU使用率追踪。
• 磁盘使用追踪：通过设置track_disk_usage=True以及自定义disk_path来开启对特定分区的磁盘使用监控。

配置更改通常需要重启Jupyter服务以生效。

通过这些步骤，您可以有效地安装、配置并使用Jupyter资源使用监控扩展，以更好地掌握你的Notebook运行状况。

jupyter-resource-usage Jupyter Notebook Extension for monitoring your own Resource Usage 项目地址: https://gitcode.com/gh_mirrors/ju/jupyter-resource-usage