https://github.com/friedjof/pingping
PingPing is a Python tool that measures latency between hosts and sends the results to an MQTT server. It runs as a daemon and periodically publishes latency, packet loss, and reachability metrics.
https://github.com/friedjof/pingping
latency monitoring mqtt network network-analysis packet-loss ping pingping python reachability
Last synced: about 2 months ago
JSON representation
PingPing is a Python tool that measures latency between hosts and sends the results to an MQTT server. It runs as a daemon and periodically publishes latency, packet loss, and reachability metrics.
- Host: GitHub
- URL: https://github.com/friedjof/pingping
- Owner: Friedjof
- License: gpl-3.0
- Created: 2024-10-30T23:33:20.000Z (7 months ago)
- Default Branch: main
- Last Pushed: 2024-10-30T23:55:52.000Z (7 months ago)
- Last Synced: 2025-04-05T12:14:18.657Z (about 2 months ago)
- Topics: latency, monitoring, mqtt, network, network-analysis, packet-loss, ping, pingping, python, reachability
- Language: Python
- Homepage:
- Size: 22.5 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# PingPing
PingPing is a simple tool to measure the latency between two hosts. It is written in Python and uses the MQTT protocol to send the results to a server. PingPing runs in the background as a daemon and sends the results to the server at regular intervals.
## Installation
To install PingPing, you need to have Python 3.6 or higher installed on your system.
### 1. Clone the Repository
Clone the repository to a temporary location:
```shell
git clone https://github.com/Friedjof/PingPing.git
```
### 2. Move the Project to `/opt`
Move the project to `/opt`:
```shell
sudo mv PingPing /opt/PingPing
```
Set permissions for `/opt/PingPing`:
```shell
sudo chown -R root:root /opt/PingPing
sudo chmod -R 755 /opt/PingPing
```
### 3. Create a Virtual Environment and Install Requirements
Navigate to the project directory and create a virtual environment:
```shell
cd /opt/PingPing
```
If you don't have the `python3-venv` package installed, you can install it with the following command:
```shell
sudo apt install python3.11-venv
```
Create the virtual environment:
```shell
sudo python3 -m venv .venv
```
Activate the virtual environment:
```shell
source .venv/bin/activate
```
Install the required packages from `requirements.txt`:
```shell
sudo .venv/bin/pip install -r requirements.txt
```
### 4. Create the `.env` File
In the `/opt/PingPing` directory, create a `.env` file with the following content:
```shell
MQTT_BROKER_HOST=your-mqtt-broker-host # e.g. mqtt.eclipse.org
MQTT_BROKER_PORT=your-mqtt-broker-port # e.g. 1883
MQTT_USERNAME=your-mqtt-username # optional
MQTT_PASSWORD=your-mqtt-password # optional
PING_INTERVAL=your-ping-interval # in seconds (e.g. 60)
PING_COUNT=your-ping-count # number of pings per interval (e.g. 5), the average is calculated
PING_TARGETS=your-ping-targets # comma-separated list of targets (e.g. 'github.com,ecosia.org')
```
### 5. Configure the systemd Service
1. In the root directory of the project, you will find the `pingping.service` file. Copy it to the systemd directory:
```shell
sudo cp /opt/PingPing/pingping.service /etc/systemd/system/pingping.service
```
2. Reload the systemd daemon and enable the service to start on boot:
```shell
sudo systemctl daemon-reload
sudo systemctl enable pingping
sudo systemctl start pingping
```
Now the service is running in the background and sends the results to the MQTT server at regular intervals.
You can check the status of the service with the following command:
```shell
sudo systemctl status pingping
```
### 6. MQTT Topics
The results are sent to the following MQTT topics:
- `pingping//latency`: The latency in milliseconds (average of the pings)
- `pingping//packet_loss`: The packet loss in percentage
- `pingping//timestamp`: The timestamp of the measurement in milliseconds since epoch
- `pingping//reachable`: Whether the target is reachable or not
## Development
You can set up a mosquitto broker locally for testing purposes. The broker can be started with the following command:
1. Set up your password file:
```shell
docker run -it --rm -v $(pwd)/mosquitto/config:/mosquitto/config eclipse-mosquitto mosquitto_passwd -c /mosquitto/config/passwordfile
```
2. Start the broker:
```shell
docker compose up -d
```
> **Note:** To subscribe to the topics, you can use the [MQTT Explorer](https://mqtt-explorer.com/) or the `mosquitto_sub` command.
## License
This project is licensed under the GNU General Public License v3.0 - see the [LICENSE](LICENSE) file for details.