Skip to content

stiliajohny/python-prometheus-speedtest

Repository files navigation

Contributors Forks Stargazers Issues GPL3 License LinkedIn Ask Me Anything


Logo

python-prometheus-speedtest

Get Upload/Download, Latency metrics, for use with prometheus
Explore the docs »
Report Bug · Request Feature

Table of Contents

About The Project

Logo

Built With

  • Python
  • Speedtest

Getting Started

Prerequisites

  • Python

Installation

$ pip3 install -r requiments.txt


Usage

Run it with Python

  • Run the script with Python3
    • $ python3 ./network_latency.py
  • Get results
    • $ curl localhost:8000

Build the Docker Image

  • Build the image
    • $ docker build -t CONTAINER_NAME:vX.Y ./Dockerfile
  • To run the container
    • $ docker run -p 8000:8000/tcp ./CONTAINERNAME:vX.Y

Pull it from GitHub Container Registry

  • Pull image from the command line:

    • $ docker pull docker.pkg.github.com/stiliajohny/python-prometheus-speedtest/python-prometheus-speedtest:0.0.1aplha
  • Use as base image in DockerFile:

    • FROM docker.pkg.github.com/stiliajohny/python-prometheus-speedtest/python-prometheus-speedtest:0.0.1aplha

Roadmap

See the open issues for a list of proposed features (and known issues).


Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are greatly appreciated.

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

License

Distributed under the GPL-3.0 License. See LICENSE for more information.

Contact

John Stilia - stilia.johny@gmail.com


Acknowledgements