1
0
forked from MTSR/mapserver

updated docs

This commit is contained in:
NatureFreshMilk 2019-02-15 10:33:34 +01:00
parent 3835d05420
commit 7c0cabe5f9
4 changed files with 50 additions and 2 deletions

View File

@ -25,11 +25,12 @@ The mapserver will generate a fresh `mapserver.json` if there is none at startup
```json
{
"port": 8080,
"enableprometheus": true,
"enablerendering": true,
"webdev": false,
"webapi": {
"enablemapblock": false,
"secretkey": "ZJoSpysiKGlYexof"
"secretkey": "OYHuTRbhSQXkHcwu"
},
"layers": [
{
@ -41,7 +42,22 @@ The mapserver will generate a fresh `mapserver.json` if there is none at startup
],
"renderingfetchlimit": 1000,
"renderingjobs": 2,
"renderingqueue": 100
"renderingqueue": 100,
"mapobjects": {
"bones": true,
"protector": true,
"technic": true,
"luacontroller": true,
"digiterms": true,
"digilines": true,
"travelnet": true,
"mapserver": true,
"mission": true,
"jumpdrive": true,
"smartshop": true,
"fancyvend": true,
"atm": true
}
}
```
@ -79,3 +95,6 @@ existing tiles and start rendering from scratch.
#### renderingjobs
Number of cores to use for rendering, defaults to all available cores
#### enableprometheus
Enables the [Prometheus](./prometheus.md) metrics endpoint

View File

@ -27,3 +27,7 @@ It is advisable to pipe the debug output to a file for later inspection:
```
./mapserver -debug > debug.txt
```
## Config
`./mapserver -createconfig`
Creates a config and exits

12
doc/prometheus.md Normal file
View File

@ -0,0 +1,12 @@
# Prometheus monitoring
The mapserver exposes a prometheus endpoint at the `/metrics` path
An overview of the collected metrics:
* tiledb get/set histogram
* cache hit/misses
* mapblock parse duration histogram
* mapblock render duration histogram
* tile render duration histogram
* various counters

View File

@ -21,7 +21,9 @@ Realtime mapserver for [Minetest](https://minetest.net)
* Realtime player and world stats
* Configurable layers (default: "Base" from y -16 to 160)
* POI markers / mod integration
* Protector display
* LCD Displays as markers
* Monitoring with [Prometheus](doc/prometheus.md)
## Planned Features
@ -41,6 +43,17 @@ Realtime mapserver for [Minetest](https://minetest.net)
## Terminal
<img src="./pics/terminal.png">
## Map objects (as markers)
Enable/Disable those in the [Configuration](doc/config.md)
<img src="./pics/bones.png">
<img src="./pics/digiterms.png">
<img src="./pics/lcd_display.png">
<img src="./pics/poi.png">
<img src="./pics/protectors.png">
<img src="./pics/travelnet.png">
# Bugs
There will be bugs, please file them in the [issues](./issues) page.