Performs speedtest-cli tests and pushes metrics to Prometheus Pushgateway
Project description
Prometheus Speedtest
Performs Speedtest.net tests and pushes their results to Prometheus Pushgateway.
Getting Started
These instructions will install prometheus_speedtest
on your system.
Prerequisites
Installing
pip install prometheus_speedtest
Running
prometheus_speedtest
Usage
usage: prometheus_speedtest [-h] [-s addr] [-t sec] [-p host:port] [-n name]
Export speedtest metrics to Prometheus Pushgateway.
optional arguments:
-h, --help show this help message and exit
-s addr, --source_address addr
IP address for speedtest to bind to.
-t sec, --timeout sec
Speedtest timeout, seconds.
-p host:port, --pushgateway host:port
Address of Prometheus Pushgateway.
-n name, --name name Job name to report Prometheus metrics as.
Getting Started (Development)
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.
Prerequisites
Compiling
bazel build //:prometheus_speedtest
Running
bazel run //:prometheus_speedtest
Testing
bazel test //:prometheus_speedtest_test
Contributing
Pull requests welcome. Please adhere to the Google Python style guide.
Deploying
pypi
python3 setup.py sdist
twine upload dist/*
par_binary
bazel build //:prometheus_speedtest.par
cp "$(bazel info bazel-bin)/prometheus_speedtest.par" ...
See https://github.com/google/subpar or https://google.github.io/subpar for
documentation on Python .par
files.
Debian package
bazel build //:prometheus_speedtest-debian
sudo apt install "$(bazel info bazel-bin)/prometheus_speedtest-debian.deb"
/usr/bin/prometheus_speedtest.par
If reinstalling package, remember to increment the number in version.txt
.
Otherwise apt will believe the package hasn't changed and will refuse to
install a new version.
Authors
- Jean-Ralph Aviles
License
This product is licensed under the Apache 2.0 license. See LICENSE file for details.
Acknowledgments
- Matt Martz speedtest-cli
- The Prometheus team https://prometheus.io
- Testing in Python team http://lists.idyll.org/listinfo/testing-in-python
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Hashes for prometheus_speedtest-0.1.15.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8689be99ab9ab26dc491cc5b4f27f1b79007647a51a18355a6b7c743fac3041a |
|
MD5 | ee636d9b9af9dcf9f1556740136b82d3 |
|
BLAKE2b-256 | 41aa0a8bf49e622eddd65802ea829737ca48318613ddc57a7479d2604e852478 |