Skip to content

Commit

Permalink
extended standalone docs
Browse files Browse the repository at this point in the history
  • Loading branch information
BuckarooBanzay committed Mar 10, 2020
1 parent 444428e commit 28718b7
Show file tree
Hide file tree
Showing 2 changed files with 35 additions and 25 deletions.
13 changes: 7 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,13 @@ Provides a [prometheus](https://prometheus.io) monitoring endpoint (via push-gat

## Documentation

* [Custom metrics](monitoring/doc/custom.md).
* [Exporters](monitoring/doc/exporters.md).
* [Chat commands](monitoring/doc/chatcommands.md).
* [Installation](monitoring/doc/install.md).
* [Hosted](monitoring/doc/hosted.md).
* [Docker](monitoring/doc/docker.md).
* [Custom metrics](monitoring/doc/custom.md)
* [Exporters](monitoring/doc/exporters.md)
* [Chat commands](monitoring/doc/chatcommands.md)
* [Installation of the mod](monitoring/doc/install.md)
* [Hosted](monitoring/doc/hosted.md)
* [Docker](monitoring/doc/docker.md)
* [Installation of the tools (without docker)](monitoring/doc/standalone.md)

## Features

Expand Down
47 changes: 28 additions & 19 deletions monitoring/doc/standalone.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,24 @@

# Standlone monitoring server setup
# Standalone monitoring server setup

<img src="./standalone-stack.png"></img>
Quick instructions to get the monitoring stack running locally (without docker).
For a (proper) docker setup see the `docker-compose.yml` file at https://github.com/minetest-monitoring/monitoring.minetest.land

## Prometheus
The monitoring stack:
<img src="./standalone-stack.png"></img>

https://prometheus.io/download/
Responsibilities:
* **monitoring_mod** gathers the data from within minetest and POST's them to the pushgateway
* **Pushgateway** is the "switchboard" application where the minetest-mod pushes and prometheus pulls the data
* **Prometheus** scrapes (pulls) the data from the pushgateway and persists them on-disk for later querying
* **Grafana** Retrieves the data from prometheus and visualizes it

* prometheus
## Prometheus

* Download **prometheus** from: https://prometheus.io/download/
* Extract the archive

prometheus.yml
Replace the `prometheus.yml` file with the following contents:
```yml
global:
scrape_interval: 5s
Expand All @@ -22,39 +30,40 @@ scrape_configs:
- targets: ['localhost:9091']
```


Start prometheus:
```bash
./prometheus
```


## Pushgateway

* pushgateway

* Download **pushgateway** from https://prometheus.io/download/
* Extract the archive

Start the pushgateway:
```bash
./pushgateway
```

## Grafana

https://grafana.com/grafana/download
* Download **grafana** from https://grafana.com/grafana/download
* Extract the archive

Start grafana:
```bash
./bin/grafana-server
```

http://127.0.0.1:3000/login

* admin:admin

new datasource: http://127.0.0.1:9090
* Point your browser to http://127.0.0.1:3000/login
* Use `admin` as username and `admin` as initial password to login
* Create a new datasource with URL: http://127.0.0.1:9090

### Import dashboards

dashboard-overview.json
Export a dashboard from https://monitoring.minetest.land or download the [overview](./dashboard-overview.json) dashboard.

* "+" Sign on the left
* Import
* Paste json
* Click the "+" Sign on the left
* Choose "Import"
* Paste the above json file and import the dashboard

0 comments on commit 28718b7

Please sign in to comment.