rluvaton / connection-monitor

monitoring connections using ping and display it in a compact way!

Welcome to Connection Monitor 👋

No more multiple terminal windows just to ping! use this CLI tool written in NodeJS for monitoring connections using ping and display it in a compact way!

🏠 Homepage

Install

npm i connection-monitor -g

Features

🌟 Support Windows, Mac, and Linux (for using in Alpine run apk add iputils)

🌟 Print to terminal in table view for compact results

🌟 Real-time table update

Usage

Usage: connection-monitor [options]

Options:
  --version      Show version number                                   [boolean]
  -c, --config   JSON config file that have the connection monitor data [string]
  -e, --example  Show an example File                 [boolean] [default: false]
  -d, --default  Use the default configuration        [boolean] [default: false]
  -h, --help     Show help                                             [boolean]

Examples:
  connection-monitor -c conf.json  Start monitor the connection with the data
                                   from the conf file
  connection-monitor -d            This will use the default configuration
                                   for pinging Google & CloudFlare DNS
                                   and Google & Bing Domains
  connection-monitor -e            Output example config file

Config file example

[
  {"name": "Google DNS", "ip": "8.8.8.8"},
  {"name": "CloudFlare DNS", "ip": "1.1.1.1"},
  {"name": "Google", "ip": "google.com"},
  {"name": "Bing", "ip": "bing.com"},
  {"name": "Home Server", "ip": "192.168.1.16", "description": "Ubuntu"}
]

Author

👤 Raz Luvaton

• GitHub: @rluvaton
• LinkedIn: @rluvaton

🤝 Contributing

Contributions, issues and feature requests are welcome!
Feel free to check issues page.

Show your support

Give a ⭐️ if this project helped you!

📝 License

Copyright © 2020 Raz Luvaton.
This project is MIT licensed.

connection-monitor's Issues

Add repository and issues link in package.json

Crash when passing config

When running

npm start -- -c "C:\example-conf.json"

It throws an error

(node:8112) UnhandledPromiseRejectionWarning: TypeError: configCmd is not a function
    at start (C:\Users\rluva\Programming\Unkown\NodeJS\connection-monitor\src\index.js:11:15)
    at Object.<anonymous> (C:\Users\rluva\Programming\Unkown\NodeJS\connection-monitor\bin\cli.js:4:19)
    at Module._compile (internal/modules/cjs/loader.js:1063:30)
    at Object.Module._extensions..js (internal/modules/cjs/loader.js:1103:10)
    at Module.load (internal/modules/cjs/loader.js:914:32)
    at Function.Module._load (internal/modules/cjs/loader.js:822:14)
    at Function.Module.runMain (internal/modules/cjs/loader.js:1143:12)
    at internal/main/run_main_module.js:16:11
(node:8112) UnhandledPromiseRejectionWarning: Unhandled promise rejection. This error originated either by throwing inside of an async function without a catch blo
ck, or by rejecting a promise which was not handled with .catch(). (rejection id: 1)
(node:8112) [DEP0018] DeprecationWarning: Unhandled promise rejections are deprecated. In the future, promise rejections that are not handled will terminate the No
de.js process with a non-zero exit code.

Update README to have more information

• add animation of the script in action
• add available options

IPs that having an error should be with red background

IPs that having an error should be printed with a red background and white text

Print table and immediately exit

In some environments, connection-monitor starts, print a table, and immediately exit

Tested environments:

OS	node version	Working
Debian 10	14.16.0	✅
Debian 10	14.4.0	✅
Debian 10	14.5.0	✅
WSL - Ubuntu 18.04	14.15.5	✅
WSL - Ubuntu 20.04	14.15.5	❌
WSL - Ubuntu 20.04	14.16.0	❌
WSL - Ubuntu 20.04	15.10.0	❌
MacOS - Catalina	14.~	❌
Windows	15.8.0	✅
Windows	14.15.5	✅

Tested config

[
  {"name": "Google DNS", "ip": "8.8.8.8"},
  {"name": "CloudFlare DNS", "ip": "1.1.1.1"},
  {"name": "Google", "ip": "google.com"},
  {"name": "Bing", "ip": "bing.com"},
  {"name": "Home Server", "ip": "192.168.1.16", "description": "Ubuntu"}
]

Support sections in table

To be able to output the table with sections to divide some IPs from others and set a title for each section

Delay before start pinging hostnames

IP pinging starts right away and after a couple of seconds starts pinging hostnames

Add commitlint

Support using alias for configurations

To be able to write

connection-monitor -a home

to ping all the IPs in the home configuration

Add to release an exe of the CLI

Should add an executable when automatically releasing.

Only updates part of the data in the table

In case change is true every other change will be ignored

connection-monitor/src/run.js

Lines 48 to 75 in 437f066

	const startListen = (index, target, columnsObj, tablePrint) => {
	target.pingData.on(EVENTS.DATA, ({isAlive, time, error}) => {
	let changed = false;
	if (columnsObj[COLUMNS.IS_ALIVE.key]) {
	changed = changed || tablePrint.update(index, columnsObj[COLUMNS.IS_ALIVE.key].index, isAlive, false);
	}
	if (columnsObj[COLUMNS.ADDITIONAL_DATA.key]) {
	changed = changed || tablePrint.update(index, columnsObj[COLUMNS.ADDITIONAL_DATA.key].index, isAlive ? `took ${time}ms` : '', false);
	}
	if (columnsObj[COLUMNS.ERROR.key]) {
	const errorStr = !isAlive && error && typeof error === 'object' ? error.message || error.response : '';
	changed = changed || tablePrint.update(index, columnsObj[COLUMNS.ERROR.key].index, errorStr, false);
	}
	if (changed) {
	tablePrint.refresh();
	}
	});
	target.pingData.on(EVENTS.ERROR, (err) => {
	console.error('error for ip', {ip: target.ip, err})
	});
	target.run();
	}

Can't exit

After I run the application I can't exit by pressing CTRL-C

example config file output contain comment instead of description

The output is:

Example of a config file:
[
  {"name": "Router", "ip": "192.168.1.1", "comment": ""},
  {"name": "Home Server", "ip": "192.168.1.16", "comment": "description"},
  {"name": "Local", "ip": "127.0.0.1", "comment": "Local Host"}
]

while it should be:

Example of a config file:
[
  {"name": "Router", "ip": "192.168.1.1", "description": ""},
  {"name": "Home Server", "ip": "192.168.1.16", "description": ""},
  {"name": "Local", "ip": "127.0.0.1", "description": "Local Host"}
]

Table print dont update size

Suggest migrate to table package

The automated release is failing 🚨

🚨 The automated release from the master branch failed. 🚨

I recommend you give this issue a high priority, so other packages depending on you could benefit from your bug fixes and new features.

You can find below the list of errors reported by semantic-release. Each one of them has to be resolved in order to automatically publish your package. I’m sure you can resolve this 💪.

Errors are usually caused by a misconfiguration or an authentication problem. With each error reported below you will find explanation and guidance to help you to resolve it.

Once all the errors are resolved, semantic-release will release your package the next time you push a commit to the master branch. You can also manually restart the failed CI job that runs semantic-release.

If you are not sure how to resolve this, here is some links that can help you:

• Usage documentation
• Frequently Asked Questions
• Support channels

If those don’t help, or if this issue is reporting something you think isn’t right, you can always ask the humans behind semantic-release.

---

Invalid npm token.

The npm token configured in the NPM_TOKEN environment variable must be a valid token allowing to publish to the registry https://registry.npmjs.org/.

If you are using Two-Factor Authentication, make configure the auth-only level is supported. semantic-release cannot publish with the default auth-and-writes level.

Please make sure to set the NPM_TOKEN environment variable in your CI with the exact value of the npm token.

---

Good luck with your project ✨

Your semantic-release bot 📦🚀

Add tests

Add unit tests and integration tests

Add Linux and Mac support

Currently we update the code for Windows one to be have real-time feature, but need to add this to Linux ad Mac too

Table print not responsive

When resizing terminal the output of the table messed up

On inetutils ping implementation displaying `undefinedms` and empty error column

Caused by #53 .

Failed on ping from inetutils and works on ping from iputils

Output:

+----------------+-------------+--------------+----------+------------------+-------+
| Name           | Description | IP           | Is Alive | Additional Data  | Error |
+----------------+-------------+--------------+----------+------------------+-------+
| Google DNS     |             | 8.8.8.8      | true     | took 46.364ms    |       |
+----------------+-------------+--------------+----------+------------------+-------+
| CloudFlare DNS |             | 1.1.1.1      | true     | took 77.903ms    |       |
+----------------+-------------+--------------+----------+------------------+-------+
| Google         |             | google.com   | true     | took 70.828ms    |       |
+----------------+-------------+--------------+----------+------------------+-------+
| Bing           |             | bing.com     | true     | took 11.075ms    |       |
+----------------+-------------+--------------+----------+------------------+-------+
| Home Server    | Ubuntu      | 192.168.1.16 | true     | took undefinedms |       |
+----------------+-------------+--------------+----------+------------------+-------+

Add support to urls too (google.com)