Skip to content
This repository has been archived by the owner on Sep 10, 2021. It is now read-only.

Commit

Permalink
Merge remote-tracking branch 'origin/sponge-5' into sponge-5
Browse files Browse the repository at this point in the history
  • Loading branch information
phit committed Mar 6, 2017
2 parents cd2fd5b + 729cf8e commit 1f283ee
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
# Minecraft Prometheus Exporter

A **Bukkit plugin** which exports Minecraft server stats for Prometheus.
A **Sponge plugin** which exports Minecraft server stats for Prometheus.

## Quick Start

Drop the the prometheus-exporter.jar into your Bukkit plugins directory and start your Minecraft server.
Drop the the plugin jar into your servers mods directory and start your server.

After startup, the Prometheus metrics endpoint should be available at ``localhost:9225/metrics`` (assuming localhost is the server hostname).

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

## Prometheus config

Expand Down Expand Up @@ -51,9 +51,9 @@ These are the stats that are currently exported by the plugin.

Label | Description
------------ | -------------
mc_players_total | Online and offline players
mc_players_total | Online and Max Online players
mc_tps | Overall tps
mc_loaded_chunks_total | Chunks loaded per world
mc_players_online_total | Online players per world
mc_entities_total | Entities loaded per world
mc_living_entities_total | Living entities loaded per world
mc_jvm_memory | JVM memory usage

0 comments on commit 1f283ee

Please sign in to comment.