https://github.com/sch8ill/mcmon

A Prometheus exporter to monitor Minecraft Servers using SLP
https://github.com/sch8ill/mcmon

Last synced: about 18 hours ago
JSON representation

A Prometheus exporter to monitor Minecraft Servers using SLP

• Host: GitHub
• URL: https://github.com/sch8ill/mcmon
• Owner: Sch8ill
• License: mit
• Created: 2023-12-14T17:23:20.000Z (11 months ago)
• Default Branch: master
• Last Pushed: 2024-04-09T14:28:06.000Z (7 months ago)
• Last Synced: 2024-04-09T18:07:27.294Z (7 months ago)
• Language: Go
• Homepage:
• Size: 146 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# mcmon

[![Release](https://img.shields.io/github/release/sch8ill/mcmon.svg?style=flat-square)](https://github.com/sch8ill/mcmon/releases)

[![Go Report Card](https://goreportcard.com/badge/github.com/sch8ill/mcmon)](https://goreportcard.com/report/github.com/sch8ill/mcmon)

![MIT license](https://img.shields.io/badge/license-MIT-green)

---

`mcmon` is a Prometheus exporter designed to monitor Minecraft Servers using [SLP](https://wiki.vg/Server_List_Ping), providing essential metrics to track server info and player activity.

`mcmon` is built using [mclib](https://github.com/sch8ill/mclib).

---

## Installation

### Docker

```bash

docker run -p 9100:9100 sch8ill/mcmon:latest --server 2b2t.org

```

`mcmon` can monitor multiple Minecraft Servers simultaneously: `mcmon --server mc.example.com --server foo.bar.com`

### Build

Requires:

```

go >= 1.21

make

```

Build command:

```bash

make build

```

---

## Usage

### Metrics

| name                     | description                                              | labels              | type  |

|--------------------------|----------------------------------------------------------|---------------------|-------|

| `mcmon_online`           | wether the Minecraft Server is online                    | server              | gauge |

| `mcmon_players_online`   | number of current online players on the Minecraft Server | server              | gauge |

| `mcmon_players_max`      | max number of players allowed on the Minecraft Server    | server              | gauge |

| `mcmon_version`          | version name of the Minecraft Server                     | server, version     | gauge |

| `mcmon_protocol_version` | protocol version of the Minecraft Server                 | server              | gauge |

| `mcmon_description`      | description of the Minecraft Server                      | server, description | gauge |

| `mcmon_latency`          | latency of the Minecraft Server in ms                    | server              | gauge |

### Prometheus config

Example `prometheus.yml` scrape config:

```yaml

scrape_configs:

  - job_name: mcmon

    scrape_interval: 30s

    static_configs:

      - targets: ["localhost:9100"]

```

### Grafana

An [example Grafana panel](https://github.com/Sch8ill/mcmon/blob/master/grafana/mcmon.json) can be found in the [grafana directory](https://github.com/Sch8ill/mcmon/blob/master/grafana).

![panel](./grafana/mcmon.png)

### CLI flags

```

   --server value [ --server value ]  address of the server to be monitored (default: "localhost:25565")

   --timeout value                    max timeout for SLP requests (default: 5s)

   --interval value                   interval the servers should checked in (default: 30s)

   --metrics-address value            address the Prometheus metrics exporter listens on (default: ":9100")

   --help, -h                         show help

```

## License

This package is licensed under the [MIT License](LICENSE).

---