Skip to main content
Join the official Python Developers Survey 2018 and win valuable prizes: Start the survey!

Performs speedtest-cli tests and pushes metrics to Prometheus Pushgateway

Project description

Prometheus Speedtest

Instrument Speedtest.net tests from Prometheus.

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.py [-h] [-p port]

Instrument speedtest.net speedtests from Prometheus.

optional arguments:
  -h, --help            show this help message and exit
  -p port, --port port  port to listen on.

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 with Bazel

bazel build //:prometheus_speedtest

Running with Bazel

bazel run //:prometheus_speedtest

Running without Bazel

First, ensure packages listed in requirements.txt are installed with pip.

python2 prometheus_speedtest.py

Running with Docker

  1. Using Bazel-Docker integration

Documentation

bazel run //:prometheus_speedtest_image
  1. Raw Docker
docker build -t prometheus_speedtest:latest .
docker run --rm -d -p 8080:8080/tcp prometheus_speedtest:latest

Perform a Speedtest

curl localhost:8080/probe

Or visit http://localhost:8080

Testing with Bazel

bazel test //:prometheus_speedtest_test

Testing without Bazel

python2 prometheus_speedtest_test.py

Contributing

Pull requests welcome. Please adhere to the Google Python style guide.

Deploying

pypi

python2 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.

Filename, size & hash SHA256 hash help File type Python version Upload date
prometheus_speedtest-0.1.19.tar.gz (4.8 kB) Copy SHA256 hash SHA256 Source None Sep 25, 2018

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page