https://github.com/diced/serverstats

Visualize your Minecraft server statistics in realtime
https://github.com/diced/serverstats

bukkit fabricmc minecraft paper spigot velocity

Last synced: 2 months ago
JSON representation

Visualize your Minecraft server statistics in realtime

• Host: GitHub
• URL: https://github.com/diced/serverstats
• Owner: diced
• License: mit
• Created: 2021-07-13T14:35:22.000Z (over 3 years ago)
• Default Branch: trunk
• Last Pushed: 2021-12-17T05:53:37.000Z (about 3 years ago)
• Last Synced: 2023-03-04T02:34:04.631Z (almost 2 years ago)
• Topics: bukkit, fabricmc, minecraft, paper, spigot, velocity
• Language: Java
• Homepage: https://serverstats.diced.tech/
• Size: 52.5 MB
• Stars: 10
• Watchers: 1
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# ServerStats

Visualize your Minecraft server statistics in realtime for Minecraft 1.8+ (*Only 1.17+ for Fabric*)

Want to learn more? Visit [serverstats.diced.me](https://serverstats.diced.me) for the latest downloads and documentation.

![Grafana Dashboard Example](https://raw.githubusercontent.com/diced/serverstats/trunk/example-grafana-dashboard.png)

## Downloading

There's multiple places where you can download ServerStats

### Stable Builds

* **`builds`** branch contains builds from every stable tag release

* **[Website](https://serverstats.diced.me/download)** contains the builds from stable releases

* **[GitHub Releases](https://github.com/diced/ServerStats/releases)** contains the builds from stable releases

(*[dl.diced.me/serverstats/latest](https://dl.diced.me/serverstats/latest)*)

### Development Builds (Bleeding Edge)

* **`dev-builds`** branch contains builds from every commit

* **GitHub Actions Artifacts** zip file containing jars from commit actions

## Features

* Easy: setup ServerStats in minutes

* Prometheus: export stats to prometheus

* Grafana: visualize your stats in Grafana using our provided dashboard

* Cross server compatible: works with proxy servers, Fabric and Bukkit compatible servers (Spigot, Paper, etc)

## Metrics

This is a list of all the metrics provides. The code block has the config property.

[Docs Link to Configuration](https://serverstats.diced.me/docs/config#pushable)

### Player Count `player-count`

The online player count

### Free Memory `free-memory`

Free memory in JVM

### Max Memory  `max-memory`

Max memory in JVM

### Total Memory `total-memory`

Total memory allocated to JVM

### TPS `tps`

Ticks per-second (usually 20)

### MSPT `mspt`

Milliseconds per-tick (usually below 50ms for good perf)

### CPU % `cpu`

CPU Percentage

### Loaded Chunks `loaded-chunks`

Loaded chunks in each world

### Entity Count `entity-count`

Entity count in each world

### Disk Space used `disk-space`

Disk space that each world is using

### Packets Sent/Read `packets`

Packets that are being sent to clients and being read from clients

### Garbage Collection Time `gc`

The time it took to do the last GC

### Thread Count `threads`

The amount of JVM threads

### Uptime `uptime`

The uptime of the server

## Compiling

You must be using Java 16+ as Fabric/Minecraft 1.17 requires it, or go into the directory you want and build using a different JDK.

```shell

git clone https://github.com/diced/ServerStats

cd ServerStats

./build.sh # custom build shell script that builds all modules and gives all jars in builds/

```

## Project Layout

ServerStats utilizes mono-repos/modules to have different server types in one repo.

* **Common** - Common modules with interfaces and abstract classes that bukkit/bungee/fabric/velocity use

* **Bukkit/Bungee/Fabric/Velocity** - Uses the common module's interfaces to implement a platform specific plugin