自从笔者接触 Rust 编程语言以来,大大小小的程序都是使用 Rust 编程语言来进行开发。在 Web 服务器管理方面,由于服务器环境已经不再需要安装 PHP、Node.js、Python 等网站相关套件,因此也没有一个好用的、可在本机或是远程侦测服务器状态的工具能够使用,索性就自己用 Rust 编程语言来开发一个追求性能,并针对 Linux 服务器来运行的探针──M Prober (MagicLen Prober)。

M Prober 的目标有以下几项:

  • 轻量:一个轻量、可以独立运行的探针是很重要的。试想一下,我们什么时候会需要用到探针?当然就是想要查看现在系统环境的硬件配置或是找出导致服务器在当下处理请求时变慢的原因嘛!但如果为了查看系统状态还要安装一堆有的没的套件,甚至还要用一堆程序脚本来让探针常驻在系统中来监看系统状态,岂不是本末倒置?所以 M Prober 是一个单档、可独立运行的程序,可以随时取得、随时移除。
  • 性能:M Prober 几乎只会透过 /proc 和 /sys 这两个存在于内存上的虚拟文件系统来取得系统信息,并不会去额外调用 Linux 环境中的任何 shell 指令。如果数据源有不足的部份,会直接透过 libc 来取得。
  • 集成:不像 Linux 操作系统提供的那些常用指令工具,一种只能针对一个或是少数几个方面的系统信息进行查看。M Prober 可以用来取得主机名称、Linux 内核名称、已开机时间(uptime)、系统 RTC 时间、CPU、内存、网络和硬盘(或分割区、逻辑滚动条)等的信息。(未来会再添加进程查看功能)
  • 无暂存:M Prober 所取得的数据完全不会被暂存下来,非常干净,用户不需烦恼删掉 M Prober 的可执行文件后还有剩余的垃圾要处理。
  • 完善的命令行界面(CLI):M Prober 提供完善的命令行界面,可以在用户需要使用探针功能时,取代掉零散又不统一的 Linux 内置指令。
  • 易部署的 HTTP 服务:除了命令行界面之外,M Prober 也可以当作一个 Web 应用程序来使用,它有自带的 HTTP 服务器,可让用户直接在网页上监视系统资源,并且提供以 JSON 格式来回传数据的 HTTP API。
  • 低系统需求:已确认的最低可正常运行 M Prober 的 Linux 内核版本为 3.10。
  • 无多国语言:无多国语言?不错,查看系统信息最重要的是数据,多国语言支持根本没用,徒增使用的难度罢了。

GitHub:

安装和卸载 M Prober

透过 Cargo

如果系统环境中有安装「Cargo」的话,可以直接使用以下指令来下载「M Prober」的源代码项目,并进行编译安装。

cargo install mprober

若要卸载,运行以下这个指令即可:

cargo uninstall mprober

透过 GitHub(适用于 x86 和 x86_64 架构)

运行以下指令,将最新的 M Prober 可执行文件从 GitHub 上下载下来,并移动到 /usr/local/bin 目录中。

curl -fL "$(curl -fsS https://api.github.com/repos/magiclen/m-prober/releases/latest | sed -r -n 's/.*"browser_download_url": *"(.*\/mprober_'$(uname -m)')".*/\1/p')" -O && sudo mv mprober_$(uname -m) /usr/local/bin/mprober && sudo chmod +x /usr/local/bin/mprober

若要卸载,运行以下这个指令即可:

sudo rm /usr/local/bin/mprober

使用 M Prober

命令行界面

取得主机名称
mprober hostname

除了 hostname 这个子命令外,还可以使用 h、host、name 和 servername。

以 mprober hostname 取得主机名称

取得 Linux 内核版本
mprober kernel

除了 kernel 这个子命令外,还可以使用 k、l 和 linux。

以 mprober kernel 取得内核版本

取得已开机时间(uptime)
mprober uptime

除了 uptime 这个子命令外,还可以使用 u、up、utime 和 ut。

以 mprober uptime 取得已开机时间

可以加上 -m 参数来持续监看,每秒会更新一次。

取得 RTC (Real-Time Clock)时间
mprober time

除了 time 这个子命令外,还可以使用 t、systime、stime、st、utc、utctime、rtc、rtctime 和 date。

以 mprober time 取得 RTC 时间

可以加上 -m 参数来持续监看,每秒会更新一次。

显示负载和 CPU 状态
mprober cpu

除了 cpu 这个子命令外,还可以使用 c、cpus、core、cores、load、processor 和 processors。

以 mprober cpu 显示负载和 CPU 状态

可以加上 -m 参数再接上毫秒数来持续监看。

显示内存状态
mprober memory

除了 memory 这个子命令外,还可以使用 m、mem、f、free、memories、swap、ram、dram、ddr、cache、buffer、buffers、buf 和 buff。

以 mprober memory 显示内存状态

进度条颜色的部份,红色是已使用的内存量、黄色是缓存量、蓝色是缓冲量。可以加上 -m 参数再接上毫秒数来持续监看。

显示网络状态
mprober network

除了 network 这个子命令外,还可以使用 n、net、networks、bandwidth 和 traffic。

以 mprober network 显示网络状态

可以加上 -m 参数再接上毫秒数来持续监看。

显示硬盘状态
mprober volume

除了 volume 这个子命令外,还可以使用 v、storage、volumes、d、disk、disks、blk、block、blocks、mount、mounts、ssd 和 hdd。

以 mprober volume 显示硬盘状态

可以加上 -m 参数再接上毫秒数来持续监看。

颜色模式

MPROBER_LIGHT 和 MPROBER_FORCE_PLAIN 环境变量可以用来控制 M Prober 预设的终端机输出配色。如下图:

以环境变量切换 M Prober 的配色

性能测试

以下指令可以用来测试目前系统环境的 CPU、内存和硬盘性能:

mprober benchmark

除了 benchmark 这个子命令外,还可以使用 b、bench 和 performance。

也可以加上额外的 --disable-xxx 或是 --enable-xxx 等参数来控制要跑哪些性能测试。

以 mprober benchmark 测试系统性能

Web (HTTP)

启动 M Prober 服务器
mprober web

除了 web 这个子命令外,还可以使用 w、server、http。

一旦启动了 M Prober 服务器,就可以用网页浏览器(如 Firefox、Chrome 等)打开 http://0.0.0.0:8000,来监看系统。

M Prober 的网页监看界面

如果要更改监听的连接端口,可以加上 -p 参数,再接上连接端口号码。如果要更改监看系统的侦测间隔时间,可以加上 -m 参数,再接上秒数,有效的秒数范围是 1 ~ 15。

HTTP API
GET /api/hostname
{
    "code": 0,
    "data": "magiclen-linux"
}
GET /api/kernel
{
    "code": 0,
    "data": "4.15.0-48-generic"
}
GET /api/uptime
{
    "code": 0,
    "data": 31694
}

数据的单位是秒。

GET /api/time
{
    "code": 0,
    "data": {
        "date": "2019-05-03",
        "time": "12:43:14"
    }
}

这时间是 RTC 时间。

GET /api/cpu
{
    "code": 0,
    "data": {
        "cpus": [
            {
                "cores": 4,
                "mhz": [
                    2571.96,
                    2688.208,
                    2604.095,
                    2700.238,
                    2700.034,
                    2699.908,
                    2700.329,
                    2699.986
                ],
                "model_name": "Intel(R) Core(TM) i7-6700HQ CPU @ 2.60GHz",
                "threads": 8
            }
        ],
        "load_average": {
            "fifteen": 1.02,
            "five": 0.83,
            "one": 0.61
        }
    }
}
GET /api/cpu-detect
{
    "code": 0,
    "data": {
        "cpus": [
            {
                "cores": 4,
                "mhz": [
                    1808.254,
                    1787.732,
                    1430.044,
                    1845.768,
                    1751.993,
                    1751.121,
                    1769.048,
                    1663.091
                ],
                "model_name": "Intel(R) Core(TM) i7-6700HQ CPU @ 2.60GHz",
                "threads": 8
            }
        ],
        "cpus_stat": [
            0.08386009270965024,
            0.09152542372881356,
            0.10472972972972971,
            0.11295681063122924,
            0.06418918918918919,
            0.09364548494983276,
            0.06397306397306397,
            0.053691275167785234,
            0.0821917808219178
        ],
        "load_average": {
            "fifteen": 1.02,
            "five": 0.84,
            "one": 0.74
        }
    }
}

cpus_stat 字段的第一个值(也就是索引 0 的值)为该颗 CPU 每个逻辑内核的使用率的平均值。其余的数值分别为每个逻辑内核的使用率。

GET /api/memory
{
    "code": 0,
    "data": {
        "memory": {
            "available": 22659469312,
            "buffers": 10412032,
            "cache": 19094446080,
            "free": 4154060800,
            "shared": 119246848,
            "total": 33633140736,
            "used": 10374221824
        },
        "swap": {
            "cache": 385024,
            "free": 4082888704,
            "total": 4094685184,
            "used": 11411456
        }
    }
}

数值的单位是字节。

GET /api/network-detect
{
    "code": 0,
    "data": [
        {
            "download_rate": 0.0,
            "download_total": 55713769,
            "interface": "lo",
            "upload_rate": 0.0,
            "upload_total": 55713769
        },
        {
            "download_rate": 702.0,
            "download_total": 7461474545,
            "interface": "enp0s20f0u4",
            "upload_rate": 1280.6666666666667,
            "upload_total": 331829069
        }
    ]
}

总和(total)的单位是字节,速率(rate)的单位是字节/秒。

GET /api/volume
{
    "code": 0,
    "data": [
        {
            "device": "sda2",
            "mount_points": [
                "/",
                "/var/lib/docker/btrfs"
            ],
            "read_total": 7612149760,
            "size": 249809600512,
            "used": 70506823680,
            "write_total": 12919939072
        },
        {
            "device": "sdb1",
            "mount_points": [
                "/storage"
            ],
            "read_total": 7080878080,
            "size": 239938535424,
            "used": 218200993792,
            "write_total": 21799934464
        },
        {
            "device": "sdc2",
            "mount_points": [
                "/home"
            ],
            "read_total": 27511930880,
            "size": 496011051008,
            "used": 370128474112,
            "write_total": 56615944192
        }
    ]
}

总和(total)的单位是字节。

GET /api/volume-detect
{
    "code": 0,
    "data": [
        {
            "device": "sda2",
            "mount_points": [
                "/",
                "/var/lib/docker/btrfs"
            ],
            "read_rate": 0.0,
            "read_total": 7612149760,
            "size": 249809600512,
            "used": 70506823680,
            "write_rate": 0.0,
            "write_total": 12928978944
        },
        {
            "device": "sdb1",
            "mount_points": [
                "/storage"
            ],
            "read_rate": 0.0,
            "read_total": 7080878080,
            "size": 239938535424,
            "used": 218200993792,
            "write_rate": 0.0,
            "write_total": 21799934464
        },
        {
            "device": "sdc2",
            "mount_points": [
                "/home"
            ],
            "read_rate": 0.0,
            "read_total": 27511934976,
            "size": 496011051008,
            "used": 370131861504,
            "write_rate": 4965717.333333333,
            "write_total": 56771334144
        }
    ]
}

总和(total)的单位是字节。速率(rate)的单位是字节/秒。

GET /api/all
{
    "code": 0,
    "data": {
        "cpus": [
            {
                "cores": 4,
                "mhz": [
                    1200.121,
                    1200.272,
                    1200.12,
                    1200.055,
                    1200.098,
                    1200.034,
                    1200.014,
                    1200.124
                ],
                "model_name": "Intel(R) Core(TM) i7-6700HQ CPU @ 2.60GHz",
                "threads": 8
            }
        ],
        "cpus_stat": [
            0.04951741502308015,
            0.043333333333333335,
            0.030405405405405407,
            0.05743243243243243,
            0.056666666666666664,
            0.04983388704318937,
            0.05387205387205387,
            0.05405405405405406,
            0.05067567567567568
        ],
        "hostname": "magiclen-linux",
        "kernel": "4.15.0-48-generic",
        "load_average": {
            "fifteen": 0.8,
            "five": 0.53,
            "one": 0.28
        },
        "memory": {
            "available": 22578839552,
            "buffers": 10412032,
            "cache": 19104878592,
            "free": 4062957568,
            "shared": 119230464,
            "total": 33633140736,
            "used": 10454892544
        },
        "network": [
            {
                "download_rate": 0.0,
                "download_total": 55798721,
                "interface": "lo",
                "upload_rate": 0.0,
                "upload_total": 55798721
            },
            {
                "download_rate": 9.333333333333334,
                "download_total": 7463048290,
                "interface": "enp0s20f0u4",
                "upload_rate": 28.666666666666668,
                "upload_total": 333465932
            }
        ],
        "rtc_time": {
            "date": "2019-05-03",
            "time": "12:54:34"
        },
        "swap": {
            "cache": 385024,
            "free": 4082888704,
            "total": 4094685184,
            "used": 11411456
        },
        "uptime": 32437,
        "volumes": [
            {
                "device": "sda2",
                "mount_points": [
                    "/",
                    "/var/lib/docker/btrfs"
                ],
                "read_rate": 0.0,
                "read_total": 7612149760,
                "size": 249809600512,
                "used": 70506831872,
                "write_rate": 0.0,
                "write_total": 12939075584
            },
            {
                "device": "sdb1",
                "mount_points": [
                    "/storage"
                ],
                "read_rate": 0.0,
                "read_total": 7080878080,
                "size": 239938535424,
                "used": 218200993792,
                "write_rate": 0.0,
                "write_total": 21799934464
            },
            {
                "device": "sdc2",
                "mount_points": [
                    "/home"
                ],
                "read_rate": 0.0,
                "read_total": 27521441792,
                "size": 496011051008,
                "used": 370118373376,
                "write_rate": 744106.6666666666,
                "write_total": 56883159040
            }
        ]
    }
}
授权(Authorization)

如果我们需要将 M Prober 的 HTTP API 暴露在互联网上的话,为了避免 HTTP API 都可被任何人使用,我们可以激活 M Prober 自带的简易授权机制。

当我们在使用命令行界面启动 M Prober 的 HTTP 服务的时候,可以加入 -a 参数,再接上要同意使用的授权密钥(随便自订一个别人猜不太到的字符串即可)。如此一来,每个 HTTP API 在被调用的时候,HTTP 请求中都必须要使用 Authorization 这个标头字段来存入同样的授权密钥,否则 API 就无法正确被调用。

此外,我们可能也会需要禁用网页系统监看功能,但依然保留 HTTP API。如果确定要这样的话,只需在启动 HTTP 服务的时候,于指令中加入 --only-api 参数。