From f9a4086729609a835a8edfcf4139954c60cb433e Mon Sep 17 00:00:00 2001 From: ParsaJR Date: Thu, 12 Feb 2026 11:23:05 +0330 Subject: [PATCH 1/5] Update README.md --- README.md | 45 +++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 45 insertions(+) diff --git a/README.md b/README.md index dd216d4..889de13 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,48 @@ # netexp netexp is a Prometheus exporter that provides advanced network usage metrics. + +It provides the amount of `transmitted` and `recieved` bytes in each second, +from the active network interface. besides that, it also provides the maximum `bursts` +of these two qualities, in different time durations. + +By default, the information is based on the pseudo-file `/proc/net/dev` which is +populated by the Linux kernel. + + + +## Usage +```bash +$ netexp --help + +netexp is a Prometheus exporter that provides advanced network usage metrics. + +Usage: + -burst-windows string + comma-separated burst window durations (default "1s,5s") + -iface-regexp string + regexp to match network interface names (default "^(eth\\d+|en[osp]\\d+\\S+|enx\\S+|w[lw]\\S+)$") + -interval duration + polling interval (e.g. 500ms, 1s) (default 1s) + -listen string + address to listen on (default ":9298") + -output-windows string + comma-separated output window durations (default "15s,30s,60s") + +$ netexp -listen :9290 +listening on :9298 +matched interfaces: enp0s31f6, wlp4s0 +``` + +## Exported metrics + +- `netexp_recv_bytes` The total number of bytes of data, that has been recieved + by the interface + +- `netexp_trns_bytes` The total number of bytes of data, that has been recieved + by the interface + +- `netexp_max_{burst-duration}_{direction}_burst_bps_over_{observation-duration}` +Shows how much the maximum traffic rate observed within specific time windows. +It basically shows the __The Peak Rates__ of the network interface at small. + From f70622f159a048c159ad1a1b4a19c187195aa159 Mon Sep 17 00:00:00 2001 From: ParsaJR Date: Thu, 12 Feb 2026 11:28:58 +0330 Subject: [PATCH 2/5] emoji --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 889de13..50218a0 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# netexp +# ⇄ netexp netexp is a Prometheus exporter that provides advanced network usage metrics. @@ -46,3 +46,4 @@ matched interfaces: enp0s31f6, wlp4s0 Shows how much the maximum traffic rate observed within specific time windows. It basically shows the __The Peak Rates__ of the network interface at small. + From 56578287cb7cfe2f505ac646ff9ac8263ddb32a4 Mon Sep 17 00:00:00 2001 From: ParsaJR Date: Thu, 12 Feb 2026 13:32:06 +0330 Subject: [PATCH 3/5] minor --- README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 50218a0..455d265 100644 --- a/README.md +++ b/README.md @@ -44,6 +44,7 @@ matched interfaces: enp0s31f6, wlp4s0 - `netexp_max_{burst-duration}_{direction}_burst_bps_over_{observation-duration}` Shows how much the maximum traffic rate observed within specific time windows. -It basically shows the __The Peak Rates__ of the network interface at small. +It basically shows the __The Peak Rates__ of the network interface at small time +windows. From 255342ebb7a589c4a0c7bf12c3c4246833f586dd Mon Sep 17 00:00:00 2001 From: ParsaJR Date: Thu, 12 Feb 2026 20:21:48 +0330 Subject: [PATCH 4/5] Update README --- README.md | 37 ++++++++++++++++++++++++++++++++----- 1 file changed, 32 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 455d265..166e502 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# ⇄ netexp +# netexp netexp is a Prometheus exporter that provides advanced network usage metrics. @@ -9,7 +9,12 @@ of these two qualities, in different time durations. By default, the information is based on the pseudo-file `/proc/net/dev` which is populated by the Linux kernel. +## Installation +### Using go toolchain +```go +go install github.com/layer8co/netexp/cmd/netexp@latest +``` ## Usage ```bash @@ -36,15 +41,37 @@ matched interfaces: enp0s31f6, wlp4s0 ## Exported metrics +Here is the example output: +``` +netexp_recv_bytes 1443950207 +netexp_trns_bytes 192449225 + +netexp_max_1s_recv_burst_bps_over_15s 11169295 +netexp_max_1s_trns_burst_bps_over_15s 148677 + +netexp_max_1s_recv_burst_bps_over_30s 11169295 +netexp_max_1s_trns_burst_bps_over_30s 148677 + +netexp_max_1s_recv_burst_bps_over_1m0s 11169295 +netexp_max_1s_trns_burst_bps_over_1m0s 148677 + +netexp_max_5s_recv_burst_bps_over_15s 8127323 +netexp_max_5s_trns_burst_bps_over_15s 114077 + +netexp_max_5s_recv_burst_bps_over_30s 8127323 +netexp_max_5s_trns_burst_bps_over_30s 114077 + +netexp_max_5s_recv_burst_bps_over_1m0s 8127323 +netexp_max_5s_trns_burst_bps_over_1m0s 114077 +``` + - `netexp_recv_bytes` The total number of bytes of data, that has been recieved - by the interface + by the interface. which is in our case: 1443950207 - `netexp_trns_bytes` The total number of bytes of data, that has been recieved - by the interface + by the interface. which is in our case: 192449225 - `netexp_max_{burst-duration}_{direction}_burst_bps_over_{observation-duration}` Shows how much the maximum traffic rate observed within specific time windows. It basically shows the __The Peak Rates__ of the network interface at small time windows. - - From 9a07bac189f155be7db2b2166e05a8480d6c8f17 Mon Sep 17 00:00:00 2001 From: ParsaJR Date: Thu, 12 Feb 2026 21:29:55 +0330 Subject: [PATCH 5/5] typo --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 166e502..f1d673a 100644 --- a/README.md +++ b/README.md @@ -73,5 +73,5 @@ netexp_max_5s_trns_burst_bps_over_1m0s 114077 - `netexp_max_{burst-duration}_{direction}_burst_bps_over_{observation-duration}` Shows how much the maximum traffic rate observed within specific time windows. -It basically shows the __The Peak Rates__ of the network interface at small time +It basically shows __The Peak Rates__ of the network interface at small time windows.