netqtop(8)

πŸ’– netqtop(8) πŸ’–

okay bestie, welcome to the System Manager's Manual page for netqtop πŸŽ€ it's literally the tool that tells you whether your network traffic is spread evenly across each queue on a NIC. no cap, it's so useful πŸ’…

✨ NAME ✨

netqtop is the tool that summarizes PPS, BPS, average packet size, and packet counts ordered by packet sizes on each queue of a network interface. ✨

netqtop [-n nic] [-i interval] [-t throughput]

πŸ¦‹ DESCRIPTION πŸ¦‹

okay so netqtop keeps stats for both transmitted and received packets on every queue of the interface you pick, so developers can check if traffic is balanced across them. it's giving balance 🫢

the output is a table with columns for PPS, BPS, average size, and packet counts in these ranges: [0,64), [64, 5120), [512, 2048), [2048, 16K), and [16K, 64K). it prints again every interval, which defaults to 1 second (the interval is in seconds) ⏱️

it uses the net:net_dev_start_xmit and net:netif_receive_skb kernel tracepoints. because it relies on tracepoints, it only works on Linux 4.7+. so check your kernel first, bestie 🧚

⚠️ netqtop introduces significant overhead when network traffic is large. the details are in the OVERHEAD section below, so read that before you run it on a busy box 😭

πŸ“‹ REQUIREMENTS πŸ“‹

you'll need CONFIG_bpf and bcc set up before it'll work. 🌸

πŸŽ€ OPTIONS πŸŽ€

  • -n NIC β€” pick the network interface card you want to watch πŸ’–
  • -i INTERVAL β€” print results every INTERVAL seconds. if you skip this, the default is 1 πŸ•
  • -t THROUGHPUT β€” print the BPS and PPS of each queue πŸ”₯

🌈 EXAMPLES 🌈

to account statistics on eth0 and output them every 2 seconds, run:

# netqtop -n eth0 -i 1

πŸ’€ OVERHEAD πŸ’€

😭 in a performance test, netqtop caused an overhead of up to 30% PPS drop when the printing interval was set to 1 second. so keep an eye out for packet drops while you're using it, bestie.

it also bumps ping-pong latency by about 1 usec πŸ™ˆ

πŸ“ SOURCE πŸ“

this one comes from bcc, which you can find at https://github.com/iovisor/bcc 🌷

also look in the bcc distribution for a netqtop_example.txt file. it has example usage, output, and commentary for this tool, and it's literally the best cheat sheet πŸ§šβ€β™€οΈ

🌸 OS 🌸

Linux only, babe 🐧

πŸ§ͺ STABILITY πŸ§ͺ

Unstable - in development. still cooking, so be gentle πŸ₯Ή

πŸ‘‘ AUTHOR πŸ‘‘

written by Yolandajn, the queen behind it all πŸ’œ


ok that's the whole tea 🫢 this is from the USER COMMANDS section, dated 2020-07-30, and it's about netqtop(8). periodt, go make your traffic balanced βœ¨πŸ’…πŸ¦‹