Hytale Prometheus Exporter Plugin

This plugin exposes Hytale server metrics in Prometheus format via an HTTP endpoint. It depends on Nitrado:WebServer.

Purpose of this Plugin

When running a Hytale server, operators often need to monitor server performance and health metrics. This plugin provides a Prometheus-compatible endpoint that exports structured metrics about the server, worlds, players, entities, and JVM performance.

Main Features

• Player Metrics: Number of players online per world.
• Chunk Metrics: Active chunks, loaded chunks, and generated chunks per world.
• Entity Metrics: Number of active entities per world.
• Performance Metrics: TPS (ticks per second) metrics including average, min, max, and target values per world.
• Server Configuration: Exports configured maximum view radius.
• JVM Metrics: Built-in Prometheus JVM metrics (memory, GC, threads, etc.).
• Permission-Based Access: Endpoint access is controlled via Hytale's permission system.

Installation

1. Install the Nitrado:WebServer plugin.
2. Copy the JAR of this plugin into your Hytale server's mods/ folder.

For the full documentation please see GitHub.