Skip to content

Commit

Permalink
Rearrange README a bit
Browse files Browse the repository at this point in the history
Move image with metrics to the main page
  • Loading branch information
adidenko committed Sep 13, 2024
1 parent 0619d18 commit abe4eb2
Showing 1 changed file with 12 additions and 10 deletions.
22 changes: 12 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand Down

0 comments on commit abe4eb2

Please sign in to comment.