Skip to main content

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.

PyPI status PyPI version shields.io PyPI license PyPI pyversions

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

prometheus_speedtest-0.1.16.tar.gz (4.3 kB view hashes)

Uploaded Source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page