From abe4eb2a1a22a4fa1851186d2751d159f86c0b6a Mon Sep 17 00:00:00 2001 From: Alexander Didenko Date: Fri, 13 Sep 2024 10:45:07 +0200 Subject: [PATCH] Rearrange README a bit Move image with metrics to the main page --- README.md | 22 ++++++++++++---------- 1 file changed, 12 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index a72bf1f..dcf3940 100644 --- a/README.md +++ b/README.md @@ -150,18 +150,10 @@ Please note that you can add `-name YOUR_NAME_HERE` argument to set custom `name label value for metrics exported to Prometheus. This could be useful to separate your test metrics from others. -### Grafana Dashboard - -Chart examples from [Minigun Grafana dashboard](grafana/Minigun.json): -![minigun grafana main](docs/images/minigun_main_grafana.png) -![minigun grafana tcp and dns](docs/images/minigun_tcp_dns_grafana.png) - -Please note that this dashboard was designed for a multi-cluster environment in which -every cluster has a unique `cluster_name` label on every metric, which is implemented -via Prometheus `global.external_labels` [config option](https://prometheus.io/docs/prometheus/latest/configuration/configuration/). - ## Understanding report +[![minigun metrics](docs/images/minigun-metrics.png)](docs/images/minigun-metrics.svg) + You can read detailed explanation of reported metrics by using CLI help: ```sh @@ -170,6 +162,16 @@ minigun -report-help Or by checking the [following documentation page](./docs/report-help.md) +### Grafana Dashboard + +Chart examples from [Minigun Grafana dashboard](grafana/Minigun.json): +![minigun grafana main](docs/images/minigun_main_grafana.png) +![minigun grafana tcp and dns](docs/images/minigun_tcp_dns_grafana.png) + +Please note that this dashboard was designed for a multi-cluster environment in which +every cluster has a unique `cluster_name` label on every metric, which is implemented +via Prometheus `global.external_labels` [config option](https://prometheus.io/docs/prometheus/latest/configuration/configuration/). + ## Local Development ### Prerequisites