From b11a336ecd67ca0f404e26b8dee6414c5327408f Mon Sep 17 00:00:00 2001 From: xeviff <73612508+xeviff@users.noreply.github.com> Date: Thu, 30 Jun 2022 19:45:57 +0200 Subject: [PATCH] update explanations --- README.md | 56 ++++++++++++------------------------------------------- 1 file changed, 12 insertions(+), 44 deletions(-) diff --git a/README.md b/README.md index 9287a43..b20957a 100644 --- a/README.md +++ b/README.md @@ -1,60 +1,28 @@ -# ARCHIVED - Internet Monitoring Docker Stack with Prometheus + Grafana +# Internet Service Level Agreement Monitoring Docker Stack with Prometheus, Grafana and a little python ports checker -> **ARCHIVED**: This repository has been archived. The contents have been merged into my [internet-pi](https://github.com/geerlingguy/internet-pi) repository. +> To learn more about the python ports checker use, please visit this page: https://github.com/xeviff/pyOpenPortsChecker4Prometheus Stand-up a Docker [Prometheus](http://prometheus.io/) stack containing Prometheus, Grafana with [blackbox-exporter](https://github.com/prometheus/blackbox_exporter), and [speedtest-exporter](https://github.com/MiguelNdeCarvalho/speedtest-exporter) to collect and graph home Internet reliability and throughput. -## Pre-requisites +## This is a fork -Make sure Docker and [Docker Compose](https://docs.docker.com/compose/install/) are installed on your Docker host machine. +Please, be aware this is an improvement from the following forked project, so I encourage you to get it as a first reference: +https://github.com/geerlingguy/internet-monitoring -## Quick Start +## Configurations -``` -git clone https://github.com/geerlingguy/internet-monitoring -cd internet-monitoring -docker-compose up -d -``` +That's easy, check the both projects configuration steps :wink: -Go to [http://localhost:3030/d/o9mIe_Aik/internet-connection](http://localhost:3030/d/o9mIe_Aik/internet-connection) (change `localhost` to your docker host ip/name). -## Configuration -To change what hosts you ping you change the `targets` section in [/prometheus/pinghosts.yaml](./prometheus/pinghosts.yaml) file. +## Expected result -For speedtest the only relevant configuration is how often you want the check to happen. It is at 30 minutes by default which might be too much if you have limit on downloads. This is changed by editing `scrape_interval` under `speedtest` in [/prometheus/prometheus.yml](./prometheus/prometheus.yml). - -Once configurations are done, run the following command: - - $ docker-compose up -d - -That's it. docker-compose builds the entire Grafana and Prometheus stack automagically. - -The Grafana Dashboard is now accessible via: `http://:3030` for example http://localhost:3030 - -username - admin -password - wonka (Password is stored in the `config.monitoring` env file) - -The DataSource and Dashboard for Grafana are automatically provisioned. - -If all works it should be available at http://localhost:3030/d/o9mIe_Aik/internet-connection - if no data shows up try change the timeduration to something smaller. +This is how it looks like in my NAS:
-## Interesting urls +The interesting thing is you can adjust the time visibility and get its average, for example the last 24h or even last week stats, etc. -http://localhost:9090/targets shows status of monitored targets as seen from prometheus - in this case which hosts being pinged and speedtest. note: speedtest will take a while before it shows as UP as it takes about 30s to respond. +## Troubleshooting -http://localhost:9090/graph?g0.expr=probe_http_status_code&g0.tab=1 shows prometheus value for `probe_http_status_code` for each host. You can edit/play with additional values. Useful to check everything is okey in prometheus (in case Grafana is not showing the data you expect). - -http://localhost:9115 blackbox exporter endpoint. Lets you see what have failed/succeded. - -http://localhost:9798/metrics speedtest exporter endpoint. Does take about 30 seconds to show its result as it runs an actual speedtest when requested. - -## Thanks and a disclaimer - -Thanks to @maxandersen for making the original project this fork is based on. - -Thanks to @vegasbrianc work on making a [super easy docker](https://github.com/vegasbrianc/github-monitoring) stack for running prometheus and grafana. - -This setup is not secured in any way, so please only use on non-public networks, or find a way to secure it on your own. +If any error don't hesitate to open an Issue and I'll check if I mess up during the merge :trollface: