Syrupy 技术文档

1. 安装指南

1.1 下载 Syrupy

Syrupy 是一个用于监控系统资源使用情况的 Python 脚本。你可以通过以下两种方式获取 Syrupy：

1. 从 SourceForge 下载：你可以从 SourceForge 网站下载 Syrupy 的压缩包：

   https://sourceforge.net/project/platformdownload.php?group_id=242033
   

2. 使用 Git 克隆：如果你已经安装了 Git，可以通过以下命令克隆 Syrupy 的仓库：

   git clone https://github.com/jeetsukumaran/Syrupy
   

1.2 安装 Syrupy

Syrupy 是一个自包含的单文件 Python 脚本，因此你不需要复杂的安装过程。你可以选择以下两种方式之一来安装 Syrupy：

1. 直接使用：解压下载的压缩包后，直接运行 syrupy.py 脚本即可。

2. 全局安装：如果你希望在任何地方都能调用 Syrupy，可以将其安装到系统路径中。进入解压后的目录，运行以下命令：

   sudo python setup.py install
   

2. 项目的使用说明

2.1 基本调用（默认模式）

在默认模式下，Syrupy 会监控用户指定命令执行时的资源使用情况。调用语法如下：

syrupy.py [SYRUPY 选项] 命令 [命令选项/参数]

例如：

syrupy.py /usr/local/bin/program
syrupy.py program.sh -o1 --opt2=foo -opt3="foo foo" /path/to/foo foo
syrupy.py find . -name "*.csv"
syrupy.py python script.py -o1 -o2 foo "something pithy"

2.2 基本调用（外部进程模式）

在此模式下，Syrupy 会监控系统中已经运行的进程。你可以通过以下选项指定要监控的进程：

• -p 或 --poll-pid：指定要监控的进程的 PID。
• -c 或 --poll-command：指定要监控的进程的命令字符串（支持正则表达式）。

例如：

syrupy.py -p 20912
syrupy.py --poll-pid=30011
syrupy.py -c '[P|p]ython'
syrupy.py --poll-command='.*java'

2.3 基本调用（内存使用前 N 模式）

在此模式下，Syrupy 会监控内存使用量最高的前 N 个进程。调用语法如下：

syrupy.py -m N

例如，监控内存使用量最高的 5 个进程：

syrupy.py -m 5

3. 项目 API 使用文档

3.1 输出解释

Syrupy 的输出包含以下字段：

• PID：进程标识符，操作系统内核用于唯一标识运行中的程序或进程。
• DATE：进程被轮询的日期，格式为 年-月-日。
• TIME：进程被轮询的时间，格式为 时:分:秒。
• ELAPSED：进程从启动到被轮询的总运行时间。
• CPU：进程的 CPU 使用率，表示为百分比。
• MEM：进程的内存使用率，表示为百分比。
• RSS：驻留集大小，进程占用的非交换物理内存（RAM），单位为 KB。
• VSIZE：虚拟内存大小，进程当前使用的总内存量，单位为 KB。

你可以通过以下命令查看字段的详细解释：

syrupy.py --explain

3.2 控制轮询间隔

Syrupy 默认以固定的时间间隔轮询进程的资源使用情况。你可以通过 -i 或 --interval 选项指定轮询间隔（单位为秒）。例如：

syrupy.py -i 10 -m 5

上述命令将每 10 秒轮询一次内存使用量最高的 5 个进程。

4. 项目安装方式

4.1 直接使用

解压下载的压缩包后，直接运行 syrupy.py 脚本即可。例如：

./syrupy.py -m 5

4.2 全局安装

如果你希望在任何地方都能调用 Syrupy，可以将其安装到系统路径中。进入解压后的目录，运行以下命令：

sudo python setup.py install

安装完成后，你可以直接使用 syrupy.py 命令调用 Syrupy。例如：

syrupy.py -m 5

通过以上步骤，你可以轻松安装并使用 Syrupy 来监控系统资源的使用情况。