Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/pouriyajamshidi/qwatcher
Queue watcher helps monitor TCP connections and diagnose buffer and connectivity issues on Linux machines related to input and output queues
https://github.com/pouriyajamshidi/qwatcher
buffer linux network nim queues receive send sqlite3 tcp
Last synced: 3 months ago
JSON representation
Queue watcher helps monitor TCP connections and diagnose buffer and connectivity issues on Linux machines related to input and output queues
- Host: GitHub
- URL: https://github.com/pouriyajamshidi/qwatcher
- Owner: pouriyajamshidi
- License: mit
- Created: 2022-08-07T10:29:52.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2024-06-02T17:10:17.000Z (8 months ago)
- Last Synced: 2024-06-02T19:02:43.725Z (8 months ago)
- Topics: buffer, linux, network, nim, queues, receive, send, sqlite3, tcp
- Language: Nim
- Homepage:
- Size: 1.56 MB
- Stars: 22
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Queue Watcher
---
`qwatcher` is designed to help monitor TCP connections and diagnose **buffer** and connectivity issues on Linux machines related to `input` and `output` queues.
---
## Table of Contents
- [Queue Watcher](#queue-watcher)
- [Table of Contents](#table-of-contents)
- [Why](#why)
- [How](#how)
- [Usage](#usage)
- [Available flags](#available-flags)
- [What](#what)
- [Nimble Directory](#nimble-directory)
- [Tested on](#tested-on)
- [Sponsor me](#sponsor-me)
- [Contact me](#contact-me)
- [License](#license)
---
## Why
The idea of writing this program came to me after reading a few blog posts discussing how they faced odd connectivity issues and how it ended up being related to the send and receive queues.
Had they had this tool, they would have been able to find the root cause much faster.
---
## How
1. Download and extract the file from this URL:
```bash
wget https://github.com/pouriyajamshidi/qwatcher/releases/latest/download/qwatcher.tar.gz
tar xvf qwatcher.tar.gz
```
Optionally, you can use `Nimble` for installation and skip to step 3.
```bash
nimble install qwatcher
```
2. Make it executable and if you prefer, move it to your `$PATH`:
```bash
chmod +x qwatcher
sudo cp qwatcher /usr/local/bin
```
3. Run it. There are two modes to run `qwatcher`.
1. **Write mode**. Provides two logging methods:
1. Using `--db_path` to log to a database. Default path: `/var/log/qwatcher.db`
2. Using `--log_path` to log to a text file. Default path: `/var/log/qwatcher.log`
2. **Monitor mode** (default). Prints the output to the console
> :warning: Make sure to not feed a higher number than your current buffer size to the program.
In order to get the current read and write buffer sizes, run the following commands:
```bash
cat /proc/sys/net/ipv4/tcp_rmem
cat /proc/sys/net/ipv4/tcp_wmem
```
---
### Usage
Let's explore all modes:
1. check every **5 seconds** and **log** connections that surpass **100 kilobytes** in **send** or **receive** queues to a **database** located at `/var/log/qwatcher.db`:
```bash
qwatcher --recv_q=100000 --send_q=100000 --refresh=5 --db_path=/var/log/qwatcher.db
```
Then you can check the database. For instance, connections with `receive queue` bigger than zero:
> `sqlite3` needs to be installed.
```bash
# Open the database file:
sqlite3 /var/log/qwatcher.db
# Beautify sqlite output:
.mode line
.headers on
.separator ROW "\n"
# Run your query:
sqlite> SELECT * FROM qwatcher WHERE receiveQ > 0;
```
2. Should you prefer to log the stats in a **log file** instead of a database as shown in step 1 use `--log_path`:
```bash
qwatcher --recv_q=100000 --send_q=100000 --refresh=5 --log_path=/var/log/qwatcher.log
```
Then you can use tail to check the file contents:
```bash
tail -f /var/log/qwatcher.log
```
3. **Default mode**. If you want the output to be shown on the **console** and not log to disk, use the commands above without `--log_path` or `--db_path` options:
```bash
qwatcher --recv_q=100000 --send_q=100000
```
> The default refresh interval is 10 seconds.
The sample output can be seen [here](#what)
Additionally, you can use the [accompanying systemd](qwatcher.service) service to run `qwatcher` in the background and not worry about system restarts:
```bash
sudo cp qwatcher.service /etc/systemd/system/qwatcher.service
sudo systemctl enable qwatcher.service
sudo systemctl start qwatcher.service
```
### Available flags
```console
-h, --help : show help
--recv_q, : Minimum receive-Q to trigger alert in bytes (default: 10000)
--send_q, : Minimum send-Q to trigger alert in bytes (default: 10000)
--refresh, : Refresh interval in seconds (default: 10)
--db_path, : Path to SQLite database to log reports (default: /var/log/qwatcher.db)
--log_path, : Path to log file to log reports (default: /var/log/qwatcher.log)
-v, --version, : Show version
```
> Please note that you cannot use `--db_path` and `--log_path` at the same time.
---
## What
Below output depicts the provided information for a connection:
Apart from the send and receive queues, there are additional information that can be useful to diagnose connectivity issues such as `congestion window`, `mss`, `retransmits` and more.
## Nimble Directory
This project is also hosted on [Nimble](https://nimble.directory/pkg/qwatcher).
## Tested on
Ubuntu server 22.04.
## Sponsor me
[](https://www.buymeacoffee.com/pouriyajamshidi)
[](https://github.com/sponsors/pouriyajamshidi)
## Contact me
[](https://www.linkedin.com/in/pouriya-jamshidi/)
## License
[](https://opensource.org/licenses/MIT)