minmon 0.13.0

An opinionated minimal monitoring and alarming tool
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60

# NetworkThroughput
Reads the number of bytes sent and/or received on a network interface.\
Will always report `0` units when triggered for the first time.

## Check options
| name | example | optional | default |
|:---|:---|:---:|:---|
| interfaces | `["enp0s1", "wg0"]` | ❌ | |
| received | `true` | ✔ | `false` |
| sent | `true` | ✔ | `false` |
| log_format | `"Decimal"` | ✔ | `"Binary"` |

### interfaces
List of network interfaces to check.

### received
Check received/incoming data.

### sent
Check sent/outgoing data.

### log_format
Formatting of the throughput data size for the log output.

One of:
- `"Binary"`: Powers of 1024 (KiB, MiB, GiB), max. precision 3
- `"Decimal"`: Powers of 1000 (kB, MB, GB), max. precision 3
- `"Bytes"`: Number of bytes

## Alarm options
| name | example | optional | default |
|:---|:---|:---:|:---|
| data_size | `100` | ❌ | |
| unit | `"Kilobyte"` | ✔ | `"Byte"` |

### data_size
Amount of units sent/received since the last check interval.
The alarm will be triggered if the measured value exceeds this value.

### unit
Unit of the value in "data_size".

One of:
- `"Byte"`
- `"Kilobyte"`
- `"Megabyte"`
- `"Gigabyte"`
- `"Kibibyte"`
- `"Mebibyte"`
- `"Gibibyte"`

See [Wikipedia](https://en.wikipedia.org/wiki/Byte#Multiple-byte_units) for more information.

## IDs
Equivalent to the "interfaces" config option with "[rx]" or "[tx]" suffix (e.g. `enp0s1[rx]`).

## Placeholders
- `data_size`: Measured data throughput since last check interval (in bytes).
- `data_size_bin`: Measured data throughput since last check interval (bytes in powers of 1024).
- `data_size_dec`: Measured data throughput since last check interval (bytes in powers of 1000).