Add README.md

This commit is contained in:
john 2025-11-24 15:21:22 -07:00
parent 4a051f02d9
commit 684d6ab857

32
README.md Normal file
View File

@ -0,0 +1,32 @@
# LTE/5G Router Metrics Exporter
This project provides a simple Prometheus exporter that collects signal metrics
from a local network device (commonly a home LTE/5G router) by scraping its
web interface at `http://192.168.1.1`.
The exporter parses the routers status page using BeautifulSoup and exposes
the following metrics on port **8000**:
- `snr` — Signal-to-Noise Ratio
- `rsrp` — Reference Signal Received Power
- `rsrq` — Reference Signal Received Quality
These metrics can be scraped by Prometheus and visualized in Grafana.
---
## Features
- Scrapes metrics directly from your router's HTML status page
- Exposes them in Prometheus format
- Lightweight and easy to deploy
- Designed to run continuously (default refresh interval: **10 seconds**)
---
## Requirements
Install dependencies:
```bash
pip install requests beautifulsoup4 prometheus_client