qwatcher

KO | EN

gitlite — search

#javascript #go #rust #linux #docker #nodejs #macos #java #awesome #cli #awesome-list #security #pytorch #openai

(★ 26)

Queue watcher helps monitor TCP connections and diagnose buffer and connectivity issues on Linux machines related to input and output queues

qwatcher 최신버젼 다운로드

최종 버전 다운로드 (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# 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 <https://nimble.directory/pkg/qwatcher> 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
  --recv_q,   INT               : Minimum Receive Queue in bytes to trigger a report (default: 10000)
  --send_q,   INT               : Minimum Send Queue in bytes to trigger a report (default: 10000)
  --refresh,  INT               : Refresh interval in seconds (default: 10)
  --db_path,  STRING            : Path to create an SQLite database to log reports (default: /var/log/qwatcher.db)
  --log_path, STRING (Optional) : Path to log file to write reports (default: /var/log/qwatcher.log)
  --stdout,   BOOL              : Output reports only to the stdout
  -h, --help                    : show help
  -v, --version,                : Show version

For instance:

qwatcher --recv_q:100000 --send_q:100000 --db_path:/var/log/qwatcher.db
  qwatcher --recv_q:100000 --send_q:100000 --log_path:/var/log/qwatcher.log
  qwatcher --recv_q:100000 --send_q:100000 --stdout:true
```

> 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:

![output](https://github.com/pouriyajamshidi/qwatcher/raw/master/images/qwatcher.png)

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

[!["Buy Me A Coffee"](https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png)](https://www.buymeacoffee.com/pouriyajamshidi)  
[![sponsor](https://img.shields.io/static/v1?label=Sponsor&message=%E2%9D%A4&logo=GitHub&color=%23fe8e86)](https://github.com/sponsors/pouriyajamshidi)

## Contact me

[![LinkedIn](https://img.shields.io/badge/LinkedIn-0077B5?style=for-the-badge&logo=linkedin&logoColor=white)](https://www.linkedin.com/in/pouriya-jamshidi/)

## License

[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

qwatcher

qwatcher 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

qwatcher

qwatcher 최신버젼 다운로드

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

Download README