diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index bf9b38a..a198643 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -13,6 +13,9 @@ jobs: matrix: os: [ linux, darwin, windows ] arch: [ amd64, 386 ] + exclude: + - os: darwin + arch: 386 name: Release - ${{matrix.os}}-${{matrix.arch}} runs-on: ubuntu-24.04 steps: diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..965f691 --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2023-2026 Henrik Hautakoski + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/README.md b/README.md new file mode 100644 index 0000000..71dd48d --- /dev/null +++ b/README.md @@ -0,0 +1,58 @@ +# Pinger + +**Pinger** is a lightweight, high-performance network utility written in Go. +It enables users to send ICMP echo requests (pings) to specified hosts, facilitating network diagnostics and monitoring. + +## Features + +* Send ICMP echo requests to specified hosts. +* Measure round-trip time (RTT) for each ping. +* Support for both IPv4 and IPv6 addresses. +* Configurable number of ping attempts and intervals. +* Lightweight and efficient, suitable for scripting and automation. + +## Installation + +### Prerequisites + +* Go (version 1.20 or later) installed on your system. +* make + +### Steps + +1. Clone the repository: + +```bash +git clone https://github.com/pnx/pinger.git +cd pinger +``` + +2. Build the application: + +```bash +make +``` + +## Usage + +See `./pinger -h` + +### Example + +```bash +./pinger --udp -t 30s example.com +``` + +This command sends UDP echo requests to example.com, stopping after 30 seconds + +```bash +./pinger -c 8 -i 1s example.com +``` + +This command sends 8 ICMP echo requests to example.com, with a 1-second interval between pings. + +NOTE: this requires root privileges + +## License + +This project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details. diff --git a/go.mod b/go.mod index 3598691..d240580 100644 --- a/go.mod +++ b/go.mod @@ -1,6 +1,6 @@ module pinger -go 1.19 +go 1.20 require ( github.com/pborman/getopt/v2 v2.1.0 diff --git a/main.go b/main.go index 69c24a2..d3f7f20 100644 --- a/main.go +++ b/main.go @@ -12,9 +12,7 @@ import ( ) // printStats prints statistics from a ping. -func printStats(pinger *probing.Pinger) { - stats := pinger.Statistics() - +func printStats(stats *probing.Statistics) { fmt.Printf("%d packets transmitted, %d packets received, %.2f%% packet loss\n", stats.PacketsSent, stats.PacketsRecv, stats.PacketLoss) @@ -34,11 +32,11 @@ func eventLoop(pinger *probing.Pinger, ticker *time.Ticker) { select { // Got signal. stop pinger and exit goroutine case s := <-sig: - fmt.Printf("Recived signal: %s, exiting.", s) + fmt.Printf("Recived signal: %s, exiting.\n", s) return // Ticker ticks. print stats. case <-ticker.C: - printStats(pinger) + printStats(pinger.Statistics()) } } } @@ -59,7 +57,7 @@ func main() { getopt.Parse() if *version { - fmt.Println("Version 0.0.3") + fmt.Println("Version 0.0.4") os.Exit(0) } @@ -80,6 +78,7 @@ func main() { pinger.Source = *source pinger.Count = *count pinger.RecordRtts = *record_rtt + pinger.OnFinish = printStats if timeout != nil && *timeout > 0 { pinger.Timeout = *timeout } @@ -91,6 +90,5 @@ func main() { fmt.Println("PING", pinger.Addr()) if err = pinger.Run(); err != nil { fmt.Println("Error:", err) - return } }