Compare commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
5017887429 | ||
|
|
fa2aec3502 | ||
|
|
5d0bf94dff | ||
|
|
e91797d9ac | ||
|
|
6952ba6975 | ||
|
|
83b66ce262 | ||
|
|
1bad62513f | ||
|
|
50840bdfb7 | ||
|
|
f91d289d8a | ||
|
|
aca7a81ad3 | ||
|
|
dc539e83d1 | ||
|
|
ec07769ff8 | ||
|
|
b2558b8855 | ||
|
|
58e692833e | ||
|
|
2648897197 | ||
|
|
7f48256f7d | ||
|
|
79a83d3c1c | ||
|
|
3be6e7e18c |
@@ -23,7 +23,7 @@ jobs:
|
||||
- name: Set up Node
|
||||
uses: actions/setup-node@v4
|
||||
with:
|
||||
node-version: 20
|
||||
node-version: 22.14.0
|
||||
|
||||
- name: Install Node dependencies
|
||||
run: npm install
|
||||
|
||||
+1
-1
@@ -1,4 +1,4 @@
|
||||
FROM gradle:8.6-jdk21
|
||||
FROM gradle:9.3-jdk21
|
||||
|
||||
WORKDIR /workspace
|
||||
|
||||
|
||||
@@ -51,6 +51,7 @@ http:
|
||||
metrics:
|
||||
enable_jvm: true
|
||||
enable_process: true
|
||||
entity_snapshot_interval_seconds: 15
|
||||
movement:
|
||||
count_block_changes_only: true
|
||||
```
|
||||
@@ -77,7 +78,7 @@ The Gitea workflow expects these secrets/variables:
|
||||
|
||||
## 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 |
|
||||
| --- | --- | --- | --- |
|
||||
|
||||
Vendored
BIN
Binary file not shown.
+1
-1
@@ -1,6 +1,6 @@
|
||||
distributionBase=GRADLE_USER_HOME
|
||||
distributionPath=wrapper/dists
|
||||
distributionUrl=https\://services.gradle.org/distributions/gradle-8.14.3-bin.zip
|
||||
distributionUrl=https\://services.gradle.org/distributions/gradle-9.3.0-bin.zip
|
||||
networkTimeout=10000
|
||||
validateDistributionUrl=true
|
||||
zipStoreBase=GRADLE_USER_HOME
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
#!/bin/sh
|
||||
|
||||
#
|
||||
# Copyright © 2015-2021 the original authors.
|
||||
# Copyright © 2015 the original authors.
|
||||
#
|
||||
# Licensed under the Apache License, Version 2.0 (the "License");
|
||||
# you may not use this file except in compliance with the License.
|
||||
@@ -114,7 +114,6 @@ case "$( uname )" in #(
|
||||
NONSTOP* ) nonstop=true ;;
|
||||
esac
|
||||
|
||||
CLASSPATH="\\\"\\\""
|
||||
|
||||
|
||||
# Determine the Java command to use to start the JVM.
|
||||
@@ -172,7 +171,6 @@ fi
|
||||
# For Cygwin or MSYS, switch paths to Windows format before running java
|
||||
if "$cygwin" || "$msys" ; then
|
||||
APP_HOME=$( cygpath --path --mixed "$APP_HOME" )
|
||||
CLASSPATH=$( cygpath --path --mixed "$CLASSPATH" )
|
||||
|
||||
JAVACMD=$( cygpath --unix "$JAVACMD" )
|
||||
|
||||
@@ -212,7 +210,6 @@ DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"'
|
||||
|
||||
set -- \
|
||||
"-Dorg.gradle.appname=$APP_BASE_NAME" \
|
||||
-classpath "$CLASSPATH" \
|
||||
-jar "$APP_HOME/gradle/wrapper/gradle-wrapper.jar" \
|
||||
"$@"
|
||||
|
||||
|
||||
Vendored
+1
-2
@@ -70,11 +70,10 @@ goto fail
|
||||
:execute
|
||||
@rem Setup the command line
|
||||
|
||||
set CLASSPATH=
|
||||
|
||||
|
||||
@rem Execute Gradle
|
||||
"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" -jar "%APP_HOME%\gradle\wrapper\gradle-wrapper.jar" %*
|
||||
"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -jar "%APP_HOME%\gradle\wrapper\gradle-wrapper.jar" %*
|
||||
|
||||
:end
|
||||
@rem End local scope for the variables with windows NT shell
|
||||
|
||||
+4
-4
@@ -2,10 +2,10 @@
|
||||
"name": "prometheus-spigot",
|
||||
"private": true,
|
||||
"devDependencies": {
|
||||
"@commitlint/cli": "^19.5.0",
|
||||
"@commitlint/config-conventional": "^19.5.0",
|
||||
"@semantic-release/exec": "^6.0.3",
|
||||
"@commitlint/cli": "^20.0.0",
|
||||
"@commitlint/config-conventional": "^20.0.0",
|
||||
"@semantic-release/exec": "^7.0.0",
|
||||
"@semantic-release/git": "^10.0.1",
|
||||
"semantic-release": "^23.1.1"
|
||||
"semantic-release": "^25.0.0"
|
||||
}
|
||||
}
|
||||
|
||||
@@ -2,11 +2,14 @@ package com.prometheus.spigot;
|
||||
|
||||
import com.prometheus.spigot.http.MetricsHttpHandler;
|
||||
import com.prometheus.spigot.listeners.BlockBreakListener;
|
||||
import com.prometheus.spigot.listeners.ChatListener;
|
||||
import com.prometheus.spigot.listeners.BlockPlaceListener;
|
||||
import com.prometheus.spigot.listeners.ChatMessageListener;
|
||||
import com.prometheus.spigot.listeners.ChunkListener;
|
||||
import com.prometheus.spigot.listeners.CommandListener;
|
||||
import com.prometheus.spigot.listeners.ConnectionListener;
|
||||
import com.prometheus.spigot.listeners.CraftListener;
|
||||
import com.prometheus.spigot.listeners.DeathListener;
|
||||
import com.prometheus.spigot.listeners.EntityKillListener;
|
||||
import com.prometheus.spigot.listeners.MoveListener;
|
||||
import com.prometheus.spigot.listeners.PluginListener;
|
||||
import com.prometheus.spigot.metrics.MetricsRegistry;
|
||||
@@ -17,7 +20,9 @@ import java.net.InetSocketAddress;
|
||||
import java.util.Locale;
|
||||
import java.util.concurrent.ExecutorService;
|
||||
import java.util.concurrent.Executors;
|
||||
import org.bukkit.Bukkit;
|
||||
import org.bukkit.plugin.java.JavaPlugin;
|
||||
import org.bukkit.scheduler.BukkitTask;
|
||||
|
||||
public final class PrometheusSpigotPlugin extends JavaPlugin {
|
||||
private HttpServer httpServer;
|
||||
@@ -25,6 +30,7 @@ public final class PrometheusSpigotPlugin extends JavaPlugin {
|
||||
private MetricsRegistry metricsRegistry;
|
||||
private String bearerToken;
|
||||
private boolean countBlockMovementOnly;
|
||||
private BukkitTask snapshotTask;
|
||||
|
||||
@Override
|
||||
public void onEnable() {
|
||||
@@ -43,6 +49,8 @@ public final class PrometheusSpigotPlugin extends JavaPlugin {
|
||||
|
||||
metricsRegistry = new MetricsRegistry(getServer(), enableJvm, enableProcess);
|
||||
|
||||
scheduleSnapshotTask();
|
||||
|
||||
registerListeners();
|
||||
startHttpServer();
|
||||
}
|
||||
@@ -57,18 +65,25 @@ public final class PrometheusSpigotPlugin extends JavaPlugin {
|
||||
httpExecutor.shutdownNow();
|
||||
httpExecutor = null;
|
||||
}
|
||||
if (snapshotTask != null) {
|
||||
snapshotTask.cancel();
|
||||
snapshotTask = null;
|
||||
}
|
||||
}
|
||||
|
||||
private void registerListeners() {
|
||||
var pluginManager = getServer().getPluginManager();
|
||||
pluginManager.registerEvents(new BlockBreakListener(metricsRegistry), this);
|
||||
pluginManager.registerEvents(new BlockPlaceListener(metricsRegistry), this);
|
||||
pluginManager.registerEvents(new DeathListener(metricsRegistry), this);
|
||||
pluginManager.registerEvents(new ChatListener(metricsRegistry), this);
|
||||
pluginManager.registerEvents(new ChatMessageListener(metricsRegistry), this);
|
||||
pluginManager.registerEvents(new MoveListener(metricsRegistry, countBlockMovementOnly), this);
|
||||
pluginManager.registerEvents(new ConnectionListener(metricsRegistry), this);
|
||||
pluginManager.registerEvents(new CommandListener(metricsRegistry), this);
|
||||
pluginManager.registerEvents(new ChunkListener(metricsRegistry), this);
|
||||
pluginManager.registerEvents(new PluginListener(metricsRegistry), this);
|
||||
pluginManager.registerEvents(new CraftListener(metricsRegistry), this);
|
||||
pluginManager.registerEvents(new EntityKillListener(metricsRegistry), this);
|
||||
}
|
||||
|
||||
private void startHttpServer() {
|
||||
@@ -95,4 +110,12 @@ public final class PrometheusSpigotPlugin extends JavaPlugin {
|
||||
httpServer.start();
|
||||
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());
|
||||
}
|
||||
}
|
||||
@@ -1,19 +0,0 @@
|
||||
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.player.AsyncPlayerChatEvent;
|
||||
|
||||
public final class ChatListener implements Listener {
|
||||
private final MetricsRegistry registry;
|
||||
|
||||
public ChatListener(MetricsRegistry registry) {
|
||||
this.registry = registry;
|
||||
}
|
||||
|
||||
@EventHandler
|
||||
public void onChat(AsyncPlayerChatEvent event) {
|
||||
registry.incrementChatMessages();
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,20 @@
|
||||
package com.prometheus.spigot.listeners;
|
||||
|
||||
import com.prometheus.spigot.metrics.MetricsRegistry;
|
||||
import io.papermc.paper.event.player.AsyncChatEvent;
|
||||
import org.bukkit.event.EventHandler;
|
||||
import org.bukkit.event.EventPriority;
|
||||
import org.bukkit.event.Listener;
|
||||
|
||||
public final class ChatMessageListener implements Listener {
|
||||
private final MetricsRegistry registry;
|
||||
|
||||
public ChatMessageListener(MetricsRegistry registry) {
|
||||
this.registry = registry;
|
||||
}
|
||||
|
||||
@EventHandler(priority = EventPriority.MONITOR, ignoreCancelled = true)
|
||||
public void onChat(AsyncChatEvent event) {
|
||||
registry.incrementChatMessages();
|
||||
}
|
||||
}
|
||||
@@ -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());
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,22 @@
|
||||
package com.prometheus.spigot.listeners;
|
||||
|
||||
import com.prometheus.spigot.metrics.MetricsRegistry;
|
||||
import org.bukkit.entity.Player;
|
||||
import org.bukkit.event.EventHandler;
|
||||
import org.bukkit.event.Listener;
|
||||
import org.bukkit.event.entity.EntityDeathEvent;
|
||||
|
||||
public final class EntityKillListener implements Listener {
|
||||
private final MetricsRegistry registry;
|
||||
|
||||
public EntityKillListener(MetricsRegistry registry) {
|
||||
this.registry = registry;
|
||||
}
|
||||
|
||||
@EventHandler
|
||||
public void onEntityDeath(EntityDeathEvent event) {
|
||||
Player killer = event.getEntity().getKiller();
|
||||
String killerLabel = killer != null ? killer.getName() : "null";
|
||||
registry.incrementEntityKill(event.getEntity().getType(), killerLabel);
|
||||
}
|
||||
}
|
||||
@@ -6,6 +6,7 @@ import java.lang.management.MemoryUsage;
|
||||
import java.lang.management.ThreadMXBean;
|
||||
import java.lang.reflect.Method;
|
||||
import java.util.ArrayList;
|
||||
import java.util.Collections;
|
||||
import java.util.Comparator;
|
||||
import java.util.HashMap;
|
||||
import java.util.List;
|
||||
@@ -31,6 +32,8 @@ public final class MetricsRegistry {
|
||||
private final Method serverMsptMethod;
|
||||
private final Method playerPingMethod;
|
||||
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 playerMovements = new LongAdder();
|
||||
@@ -41,11 +44,14 @@ public final class MetricsRegistry {
|
||||
private final LongAdder chunkGenerations = new LongAdder();
|
||||
private final LongAdder pluginEnables = 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> deathsByCause = new ConcurrentHashMap<>();
|
||||
private final ConcurrentHashMap<String, LongAdder> loginFailuresByReason = new ConcurrentHashMap<>();
|
||||
private final ConcurrentHashMap<String, LongAdder> commandsBlocked = new ConcurrentHashMap<>();
|
||||
private final ConcurrentHashMap<LabelPair, LongAdder> commandsExecuted = new ConcurrentHashMap<>();
|
||||
private final ConcurrentHashMap<String, LongAdder> itemsCraftedByMaterial = new ConcurrentHashMap<>();
|
||||
private final ConcurrentHashMap<LabelPair, LongAdder> entityKills = new ConcurrentHashMap<>();
|
||||
|
||||
public MetricsRegistry(Server server, boolean enableJvm, boolean enableProcess) {
|
||||
this.server = server;
|
||||
@@ -82,6 +88,10 @@ public final class MetricsRegistry {
|
||||
incrementLabeledCounter(blocksBrokenByMaterial, material.name());
|
||||
}
|
||||
|
||||
public void incrementBlocksPlaced(Material material) {
|
||||
incrementLabeledCounter(blocksPlacedByMaterial, material.name());
|
||||
}
|
||||
|
||||
public void incrementPlayerDeath(EntityDamageEvent.DamageCause cause) {
|
||||
incrementLabeledCounter(deathsByCause, cause.name());
|
||||
}
|
||||
@@ -120,6 +130,47 @@ public final class MetricsRegistry {
|
||||
pluginDisables.increment();
|
||||
}
|
||||
|
||||
public void incrementItemsCrafted(Material material) {
|
||||
incrementLabeledCounter(itemsCraftedByMaterial, material.name());
|
||||
}
|
||||
|
||||
public void incrementEntityKill(EntityType entityType, String killer) {
|
||||
String normalizedEntity = normalizeLabel(entityType.name());
|
||||
String normalizedKiller = normalizeLabel(killer);
|
||||
entityKills.computeIfAbsent(new LabelPair(normalizedEntity, normalizedKiller), key -> new LongAdder()).increment();
|
||||
}
|
||||
|
||||
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() {
|
||||
StringBuilder builder = new StringBuilder();
|
||||
|
||||
@@ -134,10 +185,13 @@ public final class MetricsRegistry {
|
||||
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_placed_total", "Blocks placed by material", "material", blocksPlacedByMaterial);
|
||||
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_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_items_crafted_total", "Items crafted by material", "material", itemsCraftedByMaterial);
|
||||
appendLabeledCounterAdder(builder, "spigot_entities_killed_total", "Entities killed by player", "entity", "killer", entityKills);
|
||||
|
||||
appendGauge(builder, "spigot_players_online", "Online player count", server.getOnlinePlayers().size());
|
||||
appendGauge(builder, "spigot_players_max", "Max player slots", server.getMaxPlayers());
|
||||
@@ -226,37 +280,14 @@ public final class MetricsRegistry {
|
||||
}
|
||||
|
||||
private void appendEntityMetrics(StringBuilder builder) {
|
||||
Map<String, Long> entityCounts = 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);
|
||||
}
|
||||
}
|
||||
appendLabeledGauge(builder, "spigot_entities_total", "Entities by type", "type", entityCounts);
|
||||
appendLabeledGauge(builder, "spigot_entities_total", "Entities by type", "type", entityCountsSnapshot);
|
||||
}
|
||||
|
||||
private void appendTileEntityMetrics(StringBuilder builder) {
|
||||
if (chunkTileEntitiesMethod == null) {
|
||||
return;
|
||||
}
|
||||
Map<String, Long> tileCounts = new HashMap<>();
|
||||
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);
|
||||
appendLabeledGauge(builder, "spigot_tile_entities_total", "Tile entities by type", "type", tileEntityCountsSnapshot);
|
||||
}
|
||||
|
||||
private void appendPlayerPingMetrics(StringBuilder builder) {
|
||||
|
||||
@@ -6,5 +6,6 @@ http:
|
||||
metrics:
|
||||
enable_jvm: true
|
||||
enable_process: true
|
||||
entity_snapshot_interval_seconds: 15
|
||||
movement:
|
||||
count_block_changes_only: true
|
||||
|
||||
Reference in New Issue
Block a user