Categorygithub.com/musaubrian/netmon
repositorypackage
0.0.0-20240319081951-c97eac19849c
Repository: https://github.com/musaubrian/netmon.git
Documentation: pkg.go.dev

# Packages

No description provided by the author
No description provided by the author

# README

NetMon

NetMon is a network monitoring tool(hence the name), built using Pro-bing that can be used to detect network fluctuations and alert the relevant parties.

When launched, it constantly runs an ICMP ECHO_REQUEST command(ping) and analyses the results of the command. Alerts the responsible people when the latencies exceed a pre-defined amount. It also has a web interface to visualize the results, this is shared to the people configured in config.yml

NOTE

To use it you need to clone the repo not install it using go install

Might add more unnecessary features later

Usage

Requirements

Environment variables

(See example env)

  • email n password (Get this from google)
  • ngrok token
Config options

(See example config)

  • max_latency -> expected latencies This can be the maximum latencies the ISP states, or the average in your network
  • Timeout -> How long to wait for the ping results before it cancels the ping
  • emails of the people to alert (1 or more)
Optional
  • Logo -> place this in ./web/static directory

Running it

Navigate to the root of the project

go run cmd/build.go

Tests

go test -v ./...

Known Issues

1. Graph dips to 0 a lot

Try increasing the max_latency value This happened more on windows