Skip to content

A Forge mod which exports minecraft 1.12.x server stats to Prometheus

License

Notifications You must be signed in to change notification settings

Bronuh/forge-prometheus-exporter

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

11 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Minecraft Forge Prometheus Exporter

A Forge mod which exports minecraft 1.12.x server stats to Prometheus. Based on Minecraft Prometheus Exporter for Bukkit

Quick Start

Drop the prometheusexporter.jar into your mods directory and start your Minecraft Forge server.

After startup, the Prometheus metrics endpoint should be available at localhost:9225.

The metrics port can be customized in the mod's config.cfg (a default config will be created after the first use).

Metrics command

By default everyone can use /metrics command, which shows the average TPS, online players, allocated memory and the number of loaded chunks

Default config

# Configuration file

~CONFIG_VERSION: 1.0

commands {
    B:"Admin only commands"=false
}


export {
    I:"Prometheus export port"=9225
    I:"Ticks between collecting online players"=100
    I:"Ticks between collecting performance"=40
    I:"Ticks between collecting players statistics"=1200
}


metrics {
    B:"Collect JVM memory usage metrics"=true
    B:"Collect loaded chunks"=true
    B:"Collect online players count"=true
    B:"Collect online players names"=true
    B:"Collect online players statistics"=true
    B:"Collect server TPS metrics"=true
}

About

A Forge mod which exports minecraft 1.12.x server stats to Prometheus

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages