TinyTwamp - TWAMP Server and Client in Go

This is a simple implementation of a Two-Way Active Measurement Protocol (TWAMP) server and client in a single Go binary. The server can run interactively or as a daemon, and the client can perform round-trip time (RTT) tests between itself and the server. Logs of each test are captured on both the client and the server side, and can be logged to a file. The client can be run from CRON to facilitate regular, ongoing tests. This binary should have a small enough memory and CPU requirement that it can be built and run on nearly anything and should listen and function on IPv6 as well as legacy IP (but is only tested under the current internet protocol, IPv6)

Production use

Yeah, maybe? I'm a very amateurish developer who is only learning. However, the test results are reasonably accurate now. YMMV.

Features

• TWAMP Server: Listens for test packets from a client and responds with an echo.
• TWAMP Client: Sends test packets to the server, calculates the round-trip time (RTT), and sends the RTT result back to the server.
• Logging: Detailed logs of each test are captured, including:
• Client request logs (including the test message sent).
• Server response logs (including the response sent).
• Test result logs (including round-trip time).
• User defined test count (how many sequential tests to run before stopping)

Requirements

• Go 1.16 or higher
• An environment with IPv6 support

Installation

1. Clone the repository to your local machine:

git clone https://github.com/buraglio/tiny-twamp.git
cd tiny-twamp

2. Build the project:

go build

3. Run the server or client (see below for usage).

Usage

Server Mode

You can run the server either interactively or as a daemon.

• Interactive Mode: To run the server in interactive mode and log results to a specified file:

go run tinytwamp.go -mode server -logfile /path/to/logfile.log

or

./tinytwamp -mode server -logfile /path/to/logfile.log

• Daemon Mode: To run the server as a daemon (background process) and log results:

go run tinytwamp.go -mode server -daemon true -logfile /path/to/logfile.log

or

./tinytwamp.go -mode server -daemon true -logfile /path/to/logfile.log

Client Mode

To run the client and perform a test against the server, use the following command:

go run tinytwamp.go -mode client -server fd7a:115c:a1e0::1801:7746 -logfile /path/to/logfile.log

or

./tinytwamp -mode client -server fd7a:115c:a1e0::1801:7746 -logfile /path/to/logfile.log

With a user defined amount of tests to run:

./tinytwamp -mode client -server fd7a:115c:a1e0::1801:7746 -logfile /path/to/logfile.log -c 5

• Replace fd7a:115c:a1e0::1801:7746 with the server's IPv6 address.
• The -logfile flag is optional, and if omitted, logs will be printed to stdout.

Command-Line Flags

• -mode: Specifies whether the program should run as a "client" or "server" (default is "client").
• -server: Specifies the server's IPv6 address (used only in client mode).
• -daemon: If true, runs the server as a daemon (background process).
• -logfile: Path to a file where logs will be saved. If not provided, logs will be printed to stdout.
• -count: Hand client a count of how many times to run the test. Also uses -c

Logs

• The server logs all received test packets, sent responses, and the results of each test (including round-trip time).
• The client logs the round-trip time for each test.
• Example log entries:

Server Logs:

2025/05/07 13:58:26 Received test packet from [fd7a:115c:a1e0::e501:c016]:51027: Timestamp: 2025-05-07T13:58:26-05:00
2025/05/07 13:58:26 Sent response to [fd7a:115c:a1e0::e501:c016]:51027: Round-trip time: 2025-05-07T13:58:26-05:00
2025/05/07 13:58:26 Test result for client [fd7a:115c:a1e0::e501:c016]:51027: Sent timestamp: 2025-05-07 13:58:26 -0500 CDT
2025/05/07 13:58:27 Received test packet from [fd7a:115c:a1e0::e501:c016]:51027: Timestamp: 2025-05-07T13:58:27-05:00
2025/05/07 13:58:27 Sent response to [fd7a:115c:a1e0::e501:c016]:51027: Round-trip time: 2025-05-07T13:58:27-05:00
2025/05/07 13:58:27 Test result for client [fd7a:115c:a1e0::e501:c016]:51027: Sent timestamp: 2025-05-07 13:58:27 -0500 CDT

Client Logs:

2025/05/07 13:58:26 Client received response: Round-trip time: 2025-05-07T13:58:26-05:00
2025/05/07 13:58:26 Client calculated RTT: 20.428901ms
2025/05/07 13:58:27 Client sent message: Timestamp: 2025-05-07T13:58:27-05:00
2025/05/07 13:58:28 Client received response: Round-trip time: 2025-05-07T13:58:27-05:00
2025/05/07 13:58:28 Client calculated RTT: 20.260496ms

Contribution

Feel free to fork this project and submit pull requests. If you have any issues or feature requests, please open an issue in the GitHub repository.

License

This project is licensed under the MIT License - see the LICENSE file for details.