Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/magiclen/m-prober

This program aims to collect Linux system information including hostname, kernel version, uptime, RTC time, load average, CPU, memory, network interfaces, block devices and processes. It can be used not only as a normal CLI tool, but also a web application with a front-end webpage and useful HTTP APIs.
https://github.com/magiclen/m-prober

cli linux mprober probe rust webapplication

Last synced: 28 days ago
JSON representation

Host: GitHub
URL: https://github.com/magiclen/m-prober
Owner: magiclen
License: mit
Created: 2019-05-02T07:29:01.000Z (over 5 years ago)
Default Branch: master
Last Pushed: 2024-02-21T02:50:29.000Z (10 months ago)
Last Synced: 2024-11-08T14:57:57.514Z (about 1 month ago)
Topics: cli, linux, mprober, probe, rust, webapplication
Language: Rust
Homepage:
Size: 4.4 MB
Stars: 38
Watchers: 6
Forks: 8
Open Issues: 1
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

M Prober
====================

[![CI](https://github.com/magiclen/m-prober/actions/workflows/ci.yml/badge.svg)](https://github.com/magiclen/m-prober/actions/workflows/ci.yml)

## Help

```
EXAMPLES:
mprober hostname
mprober kernel
mprober uptime
mprober uptime -m
mprober uptime -p
mprober uptime -l
mprober uptime -s
mprober time
mprober time -m
mprober time -p
mprober time -l
mprober cpu
mprober cpu -m 1000
mprober cpu -p
mprober cpu -l
mprober cpu -s
mprober cpu -i
mprober memory
mprober memory -m 1000
mprober memory -p
mprober memory -l
mprober memory -u kb
mprober network
mprober network -m 1000
mprober network -p
mprober network -l
mprober network -u kb
mprober volume
mprober volume -m 1000
mprober volume -p
mprober volume -l
mprober volume -u kb
mprober volume -i
mprober volume --mounts
mprober process
mprober process -m 1000
mprober process -p
mprober process -l
mprober process -i
mprober process -u kb
mprober process --truncate 10
mprober process --top 10
mprober process -t
mprober
mprober
mprober
mprober
mprober
mprober web
mprober web -m 2
mprober web -p 7777
mprober web --addr 127.0.0.1
mprober web -a auth_key
mprober web --only-api
mprober benchmark
mprober
mprober # Show the hostname # Show the kernel version # Show the uptime # Show the uptime and refresh every second # Show the uptime without colors # Show the uptime with darker colors (fitting in with light themes) # Show the uptime in seconds # Show the RTC (UTC) date and time # Show the RTC (UTC) date and time and refresh every second # Show the RTC (UTC) date and time without colors # Show the RTC (UTC) date and time with darker colors (fitting in with light themes) # Show load average and current CPU stats on average # Show load average and CPU stats on average and refresh every 1000 milliseconds # Show load average and current CPU stats on average without colors # Show load average and current CPU stats on average with darker colors (fitting in with light themes) # Show load average and current stats of CPU cores separately # Only show CPU information # Show current memory stats # Show memory stats and refresh every 1000 milliseconds # Show current memory stats without colors # Show current memory stats with darker colors (fitting in with light themes) # Show current memory stats in KB # Show current network stats # Show network stats and refresh every 1000 milliseconds # Show current network stats without colors # Show current network stats with darker colors (fitting in with light themes) # Show current network stats in KB # Show current volume stats # Show current volume stats and refresh every 1000 milliseconds # Show current volume stats without colors # Show current volume stats without colors # Show current volume stats in KB # Only show volume information without I/O rates # Show current volume stats including mount points # Show a snapshot of the current processes # Show a snapshot of the current processes and refresh every 1000 milliseconds # Show a snapshot of the current processes without colors # Show a snapshot of the current processes with darker colors (fitting in with light themes) # Show a snapshot of the current processes but not including CPU usage # Show a snapshot of the current processes. Information about memory size is in KB # Show a snapshot of the current processes with a specific truncation length to truncate user, group, program's names # Show a snapshot of current top-10 (ordered by CPU and memory usage) processes # Show a snapshot of the current processes with the start time of each process process --pid-filter 3456 # Show a snapshot of the current processes which are related to a specific PID process --user-filter user1 # Show a snapshot of the current processes which are related to a specific user process --group-filter gp1 # Show a snapshot of the current processes which are related to a specific group process --tty-filter tty # Show a snapshot of the current processes which are related to specific tty names matched by a regex process --program-filter ab # Show a snapshot of the current processes which are related to specific program names or commands matched by a regex # Start a HTTP service on port 8000 to monitor this computer. The default time interval is 3 seconds # Start a HTTP service on port 8000 to monitor this computer. The time interval is set to 2 seconds # Start a HTTP service on port 7777 to monitor this computer # Start a HTTP service on 127.0.0.1:8000 to monitor this computer # Start a HTTP service on port 8000 to monitor this computer. APIs need to be invoked with an auth key # Start a HTTP service on port 8000 to serve only HTTP APIs # Run benchmarks benchmark --disable-cpu # Run benchmarks except for benchmarking CPU benchmark --enable-memory # Benchmark the memory

Usage: mprober

Commands:
hostname Show the hostname
kernel Show the kernel version
uptime Show the uptime
time Show the RTC (UTC) date and time
cpu Show CPU stats
memory Show memory stats
network Show network stats
volume Show volume stats
process Show process stats
web Start a HTTP service to monitor this computer
benchmark Run benchmarks to measure the performance of this environment
help Print this message or the help of the given subcommand(s)

Options:
-h, --help Print help
-V, --version Print version
```

## Requirements

* Linux Kernel Version: 3.10+

## Usage

### Installation / Uninstallation

From [crates.io](https://crates.io/crates/mprober),

```bash
cargo install mprober

# cargo uninstall mprober
```

From [GitHub](https://github.com/magiclen/m-prober) (x86 and x86_64),

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

# sudo rm /usr/local/bin/mprober
```

### CLI

##### Get Hostname

```bash
mprober hostname
```

In addition to `hostname`, `h`, `host`, `name`, and `servername` are also acceptable.

![hostname.png](https://raw.githubusercontent.com/magiclen/m-prober/master/doc-images/hostname.png)

##### Get Kernel Version

```bash
mprober kernel
```

In addition to `kernel`, `k`, `l`, and `linux` are also acceptable.

![kernel.png](https://raw.githubusercontent.com/magiclen/m-prober/master/doc-images/kernel.png)

##### Get System Uptime

```bash
mprober uptime
```

In addition to `uptime`, `u`, `up`, `utime`, and `ut` are also acceptable.

![uptime.png](https://raw.githubusercontent.com/magiclen/m-prober/master/doc-images/uptime.png)

##### Get RTC Time

```bash
mprober time
```

In addition to `time`, `t`, `systime`, `stime`, `st`, `utc`, `utctime`, `rtc`, `rtctime`, and `date` are also acceptable.

![time.png](https://raw.githubusercontent.com/magiclen/m-prober/master/doc-images/time.png)

##### Show CPU Stats

```bash
mprober cpu
```

In addition to `cpu`, `c`, `cpus`, `core`, `cores`, `load`, `processor`, and `processors` are also acceptable.

![cpu.png](https://raw.githubusercontent.com/magiclen/m-prober/master/doc-images/cpu.png)

##### Show Memory Stats

```bash
mprober memory
```

In addition to `memory`, `m`, `mem`, `f`,`free`, `memories`, `swap`, `ram`, `dram`, `ddr`, `cache`, `buffer`, `buffers`, `buf`, and `buff` are also acceptable.

![memory.png](https://raw.githubusercontent.com/magiclen/m-prober/master/doc-images/memory.png)

##### Show Network Stats

```bash
mprober network
```

In addition to `network`, `n`, `net`, `networks`,`bandwidth`, and `traffic` are also acceptable.

![network.png](https://raw.githubusercontent.com/magiclen/m-prober/master/doc-images/network.png)

##### Show Volume Stats

```bash
mprober volume
```

In addition to `volume`, `v`, `storage`, `volumes`, `d`, `disk`, `disks`, `blk`, `block`, `blocks`, `mount`, `mounts`, `ssd`, and `hdd` are also acceptable.

![volume.png](https://raw.githubusercontent.com/magiclen/m-prober/master/doc-images/volume.png)

#### Color Mode

Environment variables, `MPROBER_LIGHT` and `MPROBER_FORCE_PLAIN` can be used to control the output colors.

![colors.png](https://raw.githubusercontent.com/magiclen/m-prober/master/doc-images/colors.png)

#### Benchmark

To benchmark the performance of CPU, memory and volumes,

```bash
mprober benchmark
```

In addition to `benchmark`, `b`, `bench`, and `performance` are also acceptable.

Adding the `--disable-xxx` or `--enable-xxx` flags can control what benchmarks you want to run.

![web.png](https://raw.githubusercontent.com/magiclen/m-prober/master/doc-images/benchmark.png)

### Web (HTTP)

#### Launching the Server

```bash
mprober web
```

In addition to `web`, `w`, `server`, and `http` are also acceptable.

Once you start the server, you can open [`http://0.0.0.0:8000`](http://0.0.0.0:8000) via a web browser such as Firefox or Chrome.

![web.png](https://raw.githubusercontent.com/magiclen/m-prober/master/doc-images/web.png)

To change the listening port, use the `-p ` option. To change the detecting time interval, use the `-m ` option, where the `` is ranged from `1` to `15`.

#### HTTP APIs

##### *GET* `/api/hostname`

```json
{
"code": 0,
"data": "magiclen-linux"
}
```

##### *GET* `/api/kernel`

```json
{
"code": 0,
"data": "4.15.0-48-generic"
}
```

##### *GET* `/api/uptime`

```json
{
"code": 0,
"data": 31694
}
```

The unit of data is **seconds**.

##### *GET* `/api/time`

```json
{
"code": 0,
"data": {
"date": "2019-05-03",
"time": "12:43:14"
}
}
```

It's RTC time.

##### *GET* `/api/cpu`

```json
{
"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`

```json
{
"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
}
}
}
```

The first value in the `cpus_stat` field is the average usage of each cores. The remaining values are the usage for each logical CPU core.

##### *GET* `/api/memory`

```json
{
"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
}
}
}
```

The unit of numbers is **bytes**.

##### *GET* `/api/network-detect`

```json
{
"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
}
]
}
```

The unit of totals is **bytes**. The unit of rates is **bytes/second**.

##### *GET* `/api/volume`

```json
{
"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
}
]
}
```

The unit of totals is **bytes**.

##### *GET* `/api/volume-detect`

```json
{
"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
}
]
}
```

The unit of totals is **bytes**. The unit of rates is **bytes/second**.

##### *GET* `/api/all`

```json
{
"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

If you need to expose above HTTP APIs to the Internet. In order to prevent these APIs from being invoked by anyone, you can enable a simple authorization mechanism that is built in this program.

When starting the HTTP server from CLI, you can add a `-a ` option. Then, every API needs to be invoked by a request which contains a `Authorization` header to send the `AUTH_KEY`.

Also, you may want to disable the web page. Just add a `--only-api` flag.

## TODO

1. Process snapshot (HTTP, documentation)
1. Database Detection
1. Benchmark (networks)

## License

[MIT](LICENSE)