2 Commits
Author SHA1 Message Date
dmg dc539e83d1 feat: add block place and craft metrics
Build / build (push) Successful in 4m54s
2026-01-27 22:34:59 -05:00
dmg 2648897197 fix: snapshot entity metrics on main thread
Build / build (push) Successful in 3m0s
2026-01-22 23:47:55 -05:00
6 changed files with 116 additions and 26 deletions
+2 -1
View File
@@ -51,6 +51,7 @@ http:
metrics: metrics:
enable_jvm: true enable_jvm: true
enable_process: true enable_process: true
entity_snapshot_interval_seconds: 15
movement: movement:
count_block_changes_only: true count_block_changes_only: true
``` ```
@@ -77,7 +78,7 @@ The Gitea workflow expects these secrets/variables:
## Metrics ## Metrics
Some metrics depend on server implementations (TPS/MSPT, player ping, tile entities). If a method is unavailable on your server build, those metrics are omitted. Some metrics depend on server implementations (TPS/MSPT, player ping, tile entities). If a method is unavailable on your server build, those metrics are omitted. Entity and tile counts are updated on a periodic main-thread snapshot.
| Metric | Type | Labels | Description | | Metric | Type | Labels | Description |
| --- | --- | --- | --- | | --- | --- | --- | --- |
@@ -2,10 +2,12 @@ package com.prometheus.spigot;
import com.prometheus.spigot.http.MetricsHttpHandler; import com.prometheus.spigot.http.MetricsHttpHandler;
import com.prometheus.spigot.listeners.BlockBreakListener; import com.prometheus.spigot.listeners.BlockBreakListener;
import com.prometheus.spigot.listeners.BlockPlaceListener;
import com.prometheus.spigot.listeners.ChatListener; import com.prometheus.spigot.listeners.ChatListener;
import com.prometheus.spigot.listeners.ChunkListener; import com.prometheus.spigot.listeners.ChunkListener;
import com.prometheus.spigot.listeners.CommandListener; import com.prometheus.spigot.listeners.CommandListener;
import com.prometheus.spigot.listeners.ConnectionListener; import com.prometheus.spigot.listeners.ConnectionListener;
import com.prometheus.spigot.listeners.CraftListener;
import com.prometheus.spigot.listeners.DeathListener; import com.prometheus.spigot.listeners.DeathListener;
import com.prometheus.spigot.listeners.MoveListener; import com.prometheus.spigot.listeners.MoveListener;
import com.prometheus.spigot.listeners.PluginListener; import com.prometheus.spigot.listeners.PluginListener;
@@ -17,7 +19,9 @@ import java.net.InetSocketAddress;
import java.util.Locale; import java.util.Locale;
import java.util.concurrent.ExecutorService; import java.util.concurrent.ExecutorService;
import java.util.concurrent.Executors; import java.util.concurrent.Executors;
import org.bukkit.Bukkit;
import org.bukkit.plugin.java.JavaPlugin; import org.bukkit.plugin.java.JavaPlugin;
import org.bukkit.scheduler.BukkitTask;
public final class PrometheusSpigotPlugin extends JavaPlugin { public final class PrometheusSpigotPlugin extends JavaPlugin {
private HttpServer httpServer; private HttpServer httpServer;
@@ -25,6 +29,7 @@ public final class PrometheusSpigotPlugin extends JavaPlugin {
private MetricsRegistry metricsRegistry; private MetricsRegistry metricsRegistry;
private String bearerToken; private String bearerToken;
private boolean countBlockMovementOnly; private boolean countBlockMovementOnly;
private BukkitTask snapshotTask;
@Override @Override
public void onEnable() { public void onEnable() {
@@ -43,6 +48,8 @@ public final class PrometheusSpigotPlugin extends JavaPlugin {
metricsRegistry = new MetricsRegistry(getServer(), enableJvm, enableProcess); metricsRegistry = new MetricsRegistry(getServer(), enableJvm, enableProcess);
scheduleSnapshotTask();
registerListeners(); registerListeners();
startHttpServer(); startHttpServer();
} }
@@ -57,11 +64,16 @@ public final class PrometheusSpigotPlugin extends JavaPlugin {
httpExecutor.shutdownNow(); httpExecutor.shutdownNow();
httpExecutor = null; httpExecutor = null;
} }
if (snapshotTask != null) {
snapshotTask.cancel();
snapshotTask = null;
}
} }
private void registerListeners() { private void registerListeners() {
var pluginManager = getServer().getPluginManager(); var pluginManager = getServer().getPluginManager();
pluginManager.registerEvents(new BlockBreakListener(metricsRegistry), this); pluginManager.registerEvents(new BlockBreakListener(metricsRegistry), this);
pluginManager.registerEvents(new BlockPlaceListener(metricsRegistry), this);
pluginManager.registerEvents(new DeathListener(metricsRegistry), this); pluginManager.registerEvents(new DeathListener(metricsRegistry), this);
pluginManager.registerEvents(new ChatListener(metricsRegistry), this); pluginManager.registerEvents(new ChatListener(metricsRegistry), this);
pluginManager.registerEvents(new MoveListener(metricsRegistry, countBlockMovementOnly), this); pluginManager.registerEvents(new MoveListener(metricsRegistry, countBlockMovementOnly), this);
@@ -69,6 +81,7 @@ public final class PrometheusSpigotPlugin extends JavaPlugin {
pluginManager.registerEvents(new CommandListener(metricsRegistry), this); pluginManager.registerEvents(new CommandListener(metricsRegistry), this);
pluginManager.registerEvents(new ChunkListener(metricsRegistry), this); pluginManager.registerEvents(new ChunkListener(metricsRegistry), this);
pluginManager.registerEvents(new PluginListener(metricsRegistry), this); pluginManager.registerEvents(new PluginListener(metricsRegistry), this);
pluginManager.registerEvents(new CraftListener(metricsRegistry), this);
} }
private void startHttpServer() { private void startHttpServer() {
@@ -95,4 +108,12 @@ public final class PrometheusSpigotPlugin extends JavaPlugin {
httpServer.start(); httpServer.start();
getLogger().info(String.format(Locale.ROOT, "Prometheus endpoint listening on http://%s:%d%s", bindAddress, port, path)); getLogger().info(String.format(Locale.ROOT, "Prometheus endpoint listening on http://%s:%d%s", bindAddress, port, path));
} }
private void scheduleSnapshotTask() {
int intervalSeconds = getConfig().getInt("metrics.entity_snapshot_interval_seconds", 15);
long intervalTicks = Math.max(20L, intervalSeconds * 20L);
metricsRegistry.refreshEntitySnapshots();
snapshotTask = Bukkit.getScheduler().runTaskTimer(this, metricsRegistry::refreshEntitySnapshots, intervalTicks, intervalTicks);
}
} }
@@ -0,0 +1,19 @@
package com.prometheus.spigot.listeners;
import com.prometheus.spigot.metrics.MetricsRegistry;
import org.bukkit.event.EventHandler;
import org.bukkit.event.Listener;
import org.bukkit.event.block.BlockPlaceEvent;
public final class BlockPlaceListener implements Listener {
private final MetricsRegistry registry;
public BlockPlaceListener(MetricsRegistry registry) {
this.registry = registry;
}
@EventHandler
public void onBlockPlace(BlockPlaceEvent event) {
registry.incrementBlocksPlaced(event.getBlockPlaced().getType());
}
}
@@ -0,0 +1,25 @@
package com.prometheus.spigot.listeners;
import com.prometheus.spigot.metrics.MetricsRegistry;
import org.bukkit.Material;
import org.bukkit.event.EventHandler;
import org.bukkit.event.Listener;
import org.bukkit.event.inventory.CraftItemEvent;
import org.bukkit.inventory.ItemStack;
public final class CraftListener implements Listener {
private final MetricsRegistry registry;
public CraftListener(MetricsRegistry registry) {
this.registry = registry;
}
@EventHandler
public void onCraft(CraftItemEvent event) {
ItemStack result = event.getRecipe() != null ? event.getRecipe().getResult() : null;
if (result == null || result.getType() == Material.AIR) {
return;
}
registry.incrementItemsCrafted(result.getType());
}
}
@@ -6,6 +6,7 @@ import java.lang.management.MemoryUsage;
import java.lang.management.ThreadMXBean; import java.lang.management.ThreadMXBean;
import java.lang.reflect.Method; import java.lang.reflect.Method;
import java.util.ArrayList; import java.util.ArrayList;
import java.util.Collections;
import java.util.Comparator; import java.util.Comparator;
import java.util.HashMap; import java.util.HashMap;
import java.util.List; import java.util.List;
@@ -31,6 +32,8 @@ public final class MetricsRegistry {
private final Method serverMsptMethod; private final Method serverMsptMethod;
private final Method playerPingMethod; private final Method playerPingMethod;
private final Method chunkTileEntitiesMethod; private final Method chunkTileEntitiesMethod;
private volatile Map<String, Long> entityCountsSnapshot = Collections.emptyMap();
private volatile Map<String, Long> tileEntityCountsSnapshot = Collections.emptyMap();
private final LongAdder chatMessages = new LongAdder(); private final LongAdder chatMessages = new LongAdder();
private final LongAdder playerMovements = new LongAdder(); private final LongAdder playerMovements = new LongAdder();
@@ -41,11 +44,13 @@ public final class MetricsRegistry {
private final LongAdder chunkGenerations = new LongAdder(); private final LongAdder chunkGenerations = new LongAdder();
private final LongAdder pluginEnables = new LongAdder(); private final LongAdder pluginEnables = new LongAdder();
private final LongAdder pluginDisables = new LongAdder(); private final LongAdder pluginDisables = new LongAdder();
private final ConcurrentHashMap<String, LongAdder> blocksPlacedByMaterial = new ConcurrentHashMap<>();
private final ConcurrentHashMap<String, LongAdder> blocksBrokenByMaterial = new ConcurrentHashMap<>(); private final ConcurrentHashMap<String, LongAdder> blocksBrokenByMaterial = new ConcurrentHashMap<>();
private final ConcurrentHashMap<String, LongAdder> deathsByCause = new ConcurrentHashMap<>(); private final ConcurrentHashMap<String, LongAdder> deathsByCause = new ConcurrentHashMap<>();
private final ConcurrentHashMap<String, LongAdder> loginFailuresByReason = new ConcurrentHashMap<>(); private final ConcurrentHashMap<String, LongAdder> loginFailuresByReason = new ConcurrentHashMap<>();
private final ConcurrentHashMap<String, LongAdder> commandsBlocked = new ConcurrentHashMap<>(); private final ConcurrentHashMap<String, LongAdder> commandsBlocked = new ConcurrentHashMap<>();
private final ConcurrentHashMap<LabelPair, LongAdder> commandsExecuted = new ConcurrentHashMap<>(); private final ConcurrentHashMap<LabelPair, LongAdder> commandsExecuted = new ConcurrentHashMap<>();
private final ConcurrentHashMap<String, LongAdder> itemsCraftedByMaterial = new ConcurrentHashMap<>();
public MetricsRegistry(Server server, boolean enableJvm, boolean enableProcess) { public MetricsRegistry(Server server, boolean enableJvm, boolean enableProcess) {
this.server = server; this.server = server;
@@ -82,6 +87,10 @@ public final class MetricsRegistry {
incrementLabeledCounter(blocksBrokenByMaterial, material.name()); incrementLabeledCounter(blocksBrokenByMaterial, material.name());
} }
public void incrementBlocksPlaced(Material material) {
incrementLabeledCounter(blocksPlacedByMaterial, material.name());
}
public void incrementPlayerDeath(EntityDamageEvent.DamageCause cause) { public void incrementPlayerDeath(EntityDamageEvent.DamageCause cause) {
incrementLabeledCounter(deathsByCause, cause.name()); incrementLabeledCounter(deathsByCause, cause.name());
} }
@@ -120,6 +129,41 @@ public final class MetricsRegistry {
pluginDisables.increment(); pluginDisables.increment();
} }
public void incrementItemsCrafted(Material material) {
incrementLabeledCounter(itemsCraftedByMaterial, material.name());
}
public void refreshEntitySnapshots() {
Map<String, Long> entityCounts = new HashMap<>();
Map<String, Long> tileCounts = new HashMap<>();
for (var world : server.getWorlds()) {
for (Entity entity : world.getEntities()) {
EntityType type = entity.getType();
String label = normalizeLabel(type.name());
entityCounts.merge(label, 1L, Long::sum);
}
if (chunkTileEntitiesMethod != null) {
for (Chunk chunk : world.getLoadedChunks()) {
Object result = invoke(chunkTileEntitiesMethod, chunk);
if (!(result instanceof Object[] states)) {
continue;
}
for (Object state : states) {
if (state instanceof BlockState blockState) {
String label = normalizeLabel(blockState.getType().name());
tileCounts.merge(label, 1L, Long::sum);
}
}
}
}
}
entityCountsSnapshot = Collections.unmodifiableMap(entityCounts);
tileEntityCountsSnapshot = Collections.unmodifiableMap(tileCounts);
}
public String render() { public String render() {
StringBuilder builder = new StringBuilder(); StringBuilder builder = new StringBuilder();
@@ -134,10 +178,12 @@ public final class MetricsRegistry {
appendCounter(builder, "spigot_plugin_disable_total", "Total plugin disable events", pluginDisables.sum()); appendCounter(builder, "spigot_plugin_disable_total", "Total plugin disable events", pluginDisables.sum());
appendLabeledCounterAdder(builder, "spigot_blocks_broken_total", "Blocks broken by material", "material", blocksBrokenByMaterial); appendLabeledCounterAdder(builder, "spigot_blocks_broken_total", "Blocks broken by material", "material", blocksBrokenByMaterial);
appendLabeledCounterAdder(builder, "spigot_blocks_placed_total", "Blocks placed by material", "material", blocksPlacedByMaterial);
appendLabeledCounterAdder(builder, "spigot_player_deaths_total", "Player deaths by cause", "cause", deathsByCause); appendLabeledCounterAdder(builder, "spigot_player_deaths_total", "Player deaths by cause", "cause", deathsByCause);
appendLabeledCounterAdder(builder, "spigot_player_logins_failed_total", "Failed player logins by reason", "reason", loginFailuresByReason); appendLabeledCounterAdder(builder, "spigot_player_logins_failed_total", "Failed player logins by reason", "reason", loginFailuresByReason);
appendLabeledCounterAdder(builder, "spigot_commands_blocked_total", "Blocked commands by name", "command", commandsBlocked); appendLabeledCounterAdder(builder, "spigot_commands_blocked_total", "Blocked commands by name", "command", commandsBlocked);
appendLabeledCounterAdder(builder, "spigot_commands_executed_total", "Commands executed by source", "command", "source", commandsExecuted); appendLabeledCounterAdder(builder, "spigot_commands_executed_total", "Commands executed by source", "command", "source", commandsExecuted);
appendLabeledCounterAdder(builder, "spigot_items_crafted_total", "Items crafted by material", "material", itemsCraftedByMaterial);
appendGauge(builder, "spigot_players_online", "Online player count", server.getOnlinePlayers().size()); appendGauge(builder, "spigot_players_online", "Online player count", server.getOnlinePlayers().size());
appendGauge(builder, "spigot_players_max", "Max player slots", server.getMaxPlayers()); appendGauge(builder, "spigot_players_max", "Max player slots", server.getMaxPlayers());
@@ -226,37 +272,14 @@ public final class MetricsRegistry {
} }
private void appendEntityMetrics(StringBuilder builder) { private void appendEntityMetrics(StringBuilder builder) {
Map<String, Long> entityCounts = new HashMap<>(); appendLabeledGauge(builder, "spigot_entities_total", "Entities by type", "type", entityCountsSnapshot);
for (var world : server.getWorlds()) {
for (Entity entity : world.getEntities()) {
EntityType type = entity.getType();
String label = normalizeLabel(type.name());
entityCounts.merge(label, 1L, Long::sum);
}
}
appendLabeledGauge(builder, "spigot_entities_total", "Entities by type", "type", entityCounts);
} }
private void appendTileEntityMetrics(StringBuilder builder) { private void appendTileEntityMetrics(StringBuilder builder) {
if (chunkTileEntitiesMethod == null) { if (chunkTileEntitiesMethod == null) {
return; return;
} }
Map<String, Long> tileCounts = new HashMap<>(); appendLabeledGauge(builder, "spigot_tile_entities_total", "Tile entities by type", "type", tileEntityCountsSnapshot);
for (var world : server.getWorlds()) {
for (Chunk chunk : world.getLoadedChunks()) {
Object result = invoke(chunkTileEntitiesMethod, chunk);
if (!(result instanceof Object[] states)) {
continue;
}
for (Object state : states) {
if (state instanceof BlockState blockState) {
String label = normalizeLabel(blockState.getType().name());
tileCounts.merge(label, 1L, Long::sum);
}
}
}
}
appendLabeledGauge(builder, "spigot_tile_entities_total", "Tile entities by type", "type", tileCounts);
} }
private void appendPlayerPingMetrics(StringBuilder builder) { private void appendPlayerPingMetrics(StringBuilder builder) {
+1
View File
@@ -6,5 +6,6 @@ http:
metrics: metrics:
enable_jvm: true enable_jvm: true
enable_process: true enable_process: true
entity_snapshot_interval_seconds: 15
movement: movement:
count_block_changes_only: true count_block_changes_only: true