https://github.com/stiliajohny/python-prometheus-speedtest
Get speedtest, ping, up/down speeds and latency on a Prometheus exporter
https://github.com/stiliajohny/python-prometheus-speedtest
grafana prometheus python3 speedtest speedtest-python
Last synced: 5 months ago
JSON representation
Get speedtest, ping, up/down speeds and latency on a Prometheus exporter
- Host: GitHub
- URL: https://github.com/stiliajohny/python-prometheus-speedtest
- Owner: stiliajohny
- License: gpl-3.0
- Created: 2020-06-28T00:09:43.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2024-11-02T07:02:06.000Z (over 1 year ago)
- Last Synced: 2024-11-02T08:16:37.177Z (over 1 year ago)
- Topics: grafana, prometheus, python3, speedtest, speedtest-python
- Language: Python
- Homepage: https://stiliajohny.github.io/python-prometheus-speedtest/
- Size: 7.29 MB
- Stars: 3
- Watchers: 3
- Forks: 0
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
[![Contributors][contributors-shield]][contributors-url]
[![Forks][forks-shield]][forks-url]
[![Stargazers][stars-shield]][stars-url]
[![Issues][issues-shield]][issues-url]
[![GPL3 License][license-shield]][license-url]
[![LinkedIn][linkedin-shield]][linkedin-url]
[![Ask Me Anything][ask-me-anything]][personal-page]
python-prometheus-speedtest
Get Upload/Download, Latency metrics, for use with prometheus
Explore the docs »
Report Bug
·
Request Feature
## Table of Contents
- [Table of Contents](#table-of-contents)
- [About The Project](#about-the-project)
- [Built With](#built-with)
- [Getting Started](#getting-started)
- [Prerequisites](#prerequisites)
- [Installation](#installation)
- [Usage](#usage)
- [Run it with Python](#run-it-with-python)
- [Build the Docker Image](#build-the-docker-image)
- [Pull it from GitHub Container Registry](#pull-it-from-github-container-registry)
- [Roadmap](#roadmap)
- [Contributing](#contributing)
- [License](#license)
- [Contact](#contact)
- [Acknowledgements](#acknowledgements)
## About The Project
### 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](https://github.com/stiliajohny/python-prometheus-speedtest/raw/main/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
- [GitHub Emoji Cheat Sheet](https://www.webpagefx.com/tools/emoji-cheat-sheet)
- [Img Shields](https://shields.io)
- [Choose an Open Source License](https://choosealicense.com)
- [GitHub Pages](https://pages.github.com)
[contributors-shield]: https://img.shields.io/github/contributors/stiliajohny/python-prometheus-speedtest.svg?style=for-the-badge
[contributors-url]: https://github.com/stiliajohny/python-prometheus-speedtest/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/stiliajohny/python-prometheus-speedtest.svg?style=for-the-badge
[forks-url]: https://github.com/stiliajohny/python-prometheus-speedtest/network/members
[stars-shield]: https://img.shields.io/github/stars/stiliajohny/python-prometheus-speedtest.svg?style=for-the-badge
[stars-url]: https://github.com/stiliajohny/python-prometheus-speedtest/stargazers
[issues-shield]: https://img.shields.io/github/issues/stiliajohny/python-prometheus-speedtest.svg?style=for-the-badge
[issues-url]: https://github.com/stiliajohny/python-prometheus-speedtest/issues
[license-shield]: https://img.shields.io/github/license/stiliajohny/python-prometheus-speedtest?style=for-the-badge
[license-url]: https://github.com/stiliajohny/python-prometheus-speedtest/blob/master/LICENSE.txt
[linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&colorB=555
[linkedin-url]: https://linkedin.com/in/johnstilia/
[product-screenshot]: .assets/screenshot.png
[ask-me-anything]: https://img.shields.io/badge/Ask%20me-anything-1abc9c.svg?style=for-the-badge
[personal-page]: https://github.com/stiliajohny