https://github.com/jonfairbanks/netmon
Publish network usage metrics to Influx Cloud
https://github.com/jonfairbanks/netmon
influxdb
Last synced: 8 months ago
JSON representation
Publish network usage metrics to Influx Cloud
- Host: GitHub
- URL: https://github.com/jonfairbanks/netmon
- Owner: jonfairbanks
- Created: 2022-04-19T07:35:42.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2022-09-09T23:20:10.000Z (about 3 years ago)
- Last Synced: 2025-01-11T02:06:15.141Z (9 months ago)
- Topics: influxdb
- Language: Python
- Homepage: https://hub.docker.com/r/jonfairbanks/netmon
- Size: 534 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# netmon
Publish network usage metrics to Influx Cloud
### Setup
- [Create a free Influx Cloud account](https://cloud2.influxdata.com/signup)
- Create an Influx Cloud Bucket (system-metrics) and API Token
### Usage
The following env variables are **required**:
- INFLUX_TOKEN: API Token provided by Influx Cloud
- INFLUX_ORG: Your Influx Cloud organization name
- INFLUX_BUCKET: Your Influx Cloud bucket name (Default: `system-metrics`)
Additional supported env variables include:
- DEBUG: Enable or disable in-app debug logging (Default: `False`)
- DEVICE: Preferred name for this device (Default: `My Device`)
- INFLUX_HOST: Host of the Influx Cloud bucket (Default: `https://us-central1-1.gcp.cloud2.influxdata.com`)
- INTERFACE: Network interface to monitor (Default: `wlan0`)
### Launch
The application can be launched with `docker-compose`:
```
docker-compose up -d
```
### Dashboard
A sample dashboard is provided in this repo and can be imported:
- Ensure that netmon is running
- Login to Influx Cloud and go to Dashboards
- Use the dropdown on `Create Dashboard` to import the template