diff --git a/.gitignore b/.gitignore index d769462..37fe707 100644 --- a/.gitignore +++ b/.gitignore @@ -32,4 +32,8 @@ build/ .vscode/ ### Mac OS ### -.DS_Store \ No newline at end of file +.DS_Store + +### Aetheria ### +**/src/main/resources/git.properties +jars \ No newline at end of file diff --git a/.idea/misc.xml b/.idea/misc.xml index 3394e6a..ea6ac46 100644 --- a/.idea/misc.xml +++ b/.idea/misc.xml @@ -1,4 +1,3 @@ - diff --git a/pom.xml b/pom.xml index 0eea259..96db512 100644 --- a/pom.xml +++ b/pom.xml @@ -9,11 +9,96 @@ 1.0-SNAPSHOT - 17 - 17 + 17 + ${java.version} + ${java.version} UTF-8 + + + + + + org.apache.maven.plugins + maven-compiler-plugin + 3.12.1 + + ${java.version} + ${java.version} + + + + false + + + + + + pl.project13.maven + git-commit-id-plugin + 4.9.10 + + + + revision + + + + + git + $PROJECT.BASEDIR$/.git + true + true + src/main/resources/git.properties + full + $USER.TIMEZONE$ + MM-dd-yyyy@HH:mm:ss + + ^git.branch$ + ^git.build.(time|version)$ + ^git.commit.id.(abbrev|full)$ + ^git.build.user.name$ + + + + + + + org.apache.maven.plugins + maven-assembly-plugin + 3.6.0 + + ./jars + false + + jar-with-dependencies + + + + + package + + single + + + + + + + + + + src/main/resources + true + + **/*.yml + **/*.properties + + + + + papermc @@ -23,6 +108,10 @@ jitpack.io https://jitpack.io/ + + placeholderapi + https://repo.extendedclip.com/content/repositories/placeholderapi/ + @@ -50,6 +139,27 @@ 2.1.3 runtime + + + me.clip + placeholderapi + 2.11.5 + provided + + + + com.github.oshi + oshi-core + 6.5.0 + compile + + + + com.influxdb + influxdb-client-java + 7.0.0 + compile + \ No newline at end of file diff --git a/src/main/java/cc/fascinated/Aetheria.java b/src/main/java/cc/fascinated/Aetheria.java index d40e43c..2f9be3e 100644 --- a/src/main/java/cc/fascinated/Aetheria.java +++ b/src/main/java/cc/fascinated/Aetheria.java @@ -1,10 +1,16 @@ package cc.fascinated; import cc.fascinated.command.CommandManager; +import cc.fascinated.metrics.MetricManager; +import cc.fascinated.placeholder.PlaceholderManager; import cc.fascinated.playercolors.ColorManager; import cc.fascinated.worldsize.WorldSizeManager; import org.bukkit.plugin.java.JavaPlugin; +import java.util.concurrent.LinkedBlockingQueue; +import java.util.concurrent.ThreadPoolExecutor; +import java.util.concurrent.TimeUnit; + public class Aetheria extends JavaPlugin { /** @@ -12,6 +18,9 @@ public class Aetheria extends JavaPlugin { */ public static Aetheria INSTANCE; + public static ThreadPoolExecutor EXECUTOR = new ThreadPoolExecutor(2, 8, 0L, TimeUnit.MILLISECONDS, new LinkedBlockingQueue<>()); + + // todo: move to config public static final String PREFIX = "§6§lAetheria §7» §f"; public Aetheria() { @@ -25,5 +34,7 @@ public class Aetheria extends JavaPlugin { new CommandManager(); new WorldSizeManager(); new ColorManager(); + new PlaceholderManager(); + new MetricManager(); } } \ No newline at end of file diff --git a/src/main/java/cc/fascinated/Oshi.java b/src/main/java/cc/fascinated/Oshi.java new file mode 100644 index 0000000..7bcfb1d --- /dev/null +++ b/src/main/java/cc/fascinated/Oshi.java @@ -0,0 +1,7 @@ +package cc.fascinated; + +import oshi.SystemInfo; + +public class Oshi { + public static final SystemInfo SYSTEM_INFO = new SystemInfo(); +} diff --git a/src/main/java/cc/fascinated/command/Command.java b/src/main/java/cc/fascinated/command/Command.java index e17927f..8762a38 100644 --- a/src/main/java/cc/fascinated/command/Command.java +++ b/src/main/java/cc/fascinated/command/Command.java @@ -1,7 +1,6 @@ package cc.fascinated.command; import lombok.Getter; -import lombok.RequiredArgsConstructor; import org.bukkit.command.CommandExecutor; import org.bukkit.command.CommandSender; import org.jetbrains.annotations.NotNull; diff --git a/src/main/java/cc/fascinated/command/impl/HelpCommand.java b/src/main/java/cc/fascinated/command/impl/HelpCommand.java index 1457866..5b7047e 100644 --- a/src/main/java/cc/fascinated/command/impl/HelpCommand.java +++ b/src/main/java/cc/fascinated/command/impl/HelpCommand.java @@ -2,10 +2,8 @@ package cc.fascinated.command.impl; import cc.fascinated.Aetheria; import cc.fascinated.command.Command; -import net.kyori.adventure.text.format.NamedTextColor; import org.bukkit.command.CommandSender; -import java.util.Map; import java.util.Objects; public class HelpCommand extends Command { diff --git a/src/main/java/cc/fascinated/metrics/Metric.java b/src/main/java/cc/fascinated/metrics/Metric.java new file mode 100644 index 0000000..fd9311c --- /dev/null +++ b/src/main/java/cc/fascinated/metrics/Metric.java @@ -0,0 +1,22 @@ +package cc.fascinated.metrics; + +import com.influxdb.client.write.Point; +import lombok.AllArgsConstructor; +import lombok.Getter; + +@AllArgsConstructor +@Getter +public abstract class Metric { + + /** + * The name of the metric. + */ + private final String name; + + /** + * Collect and return the metric. + * + * @return the collected metric + */ + protected abstract Point toPoint(); +} diff --git a/src/main/java/cc/fascinated/metrics/MetricManager.java b/src/main/java/cc/fascinated/metrics/MetricManager.java new file mode 100644 index 0000000..a5897d4 --- /dev/null +++ b/src/main/java/cc/fascinated/metrics/MetricManager.java @@ -0,0 +1,113 @@ +package cc.fascinated.metrics; + +import cc.fascinated.Aetheria; +import cc.fascinated.metrics.impl.server.MemoryMetric; +import cc.fascinated.metrics.impl.server.PlayerCountMetric; +import cc.fascinated.metrics.impl.server.TotalJoinsMetric; +import cc.fascinated.metrics.impl.server.TpsMetric; +import cc.fascinated.metrics.impl.system.CpuUsageMetric; +import cc.fascinated.metrics.impl.world.WorldSizeMetric; +import com.influxdb.client.InfluxDBClient; +import com.influxdb.client.InfluxDBClientFactory; +import com.influxdb.client.InfluxDBClientOptions; +import com.influxdb.client.WriteApiBlocking; +import com.influxdb.client.domain.WriteConsistency; +import com.influxdb.client.domain.WritePrecision; +import com.influxdb.client.write.Point; +import com.influxdb.client.write.WriteParameters; +import lombok.extern.log4j.Log4j2; +import org.bukkit.Bukkit; +import org.bukkit.configuration.file.FileConfiguration; +import org.bukkit.event.EventHandler; +import org.bukkit.event.Listener; +import org.bukkit.event.server.PluginDisableEvent; + +import java.util.ArrayList; +import java.util.List; +import java.util.concurrent.TimeUnit; + +@Log4j2 +public class MetricManager implements Listener { + + private InfluxDBClient influxDB; + private WriteApiBlocking writeApi; + private static final List metrics = new ArrayList<>(); + + public MetricManager() { + FileConfiguration config = Aetheria.INSTANCE.getConfig(); + String url = config.getString("influxdb.url"); + String token = config.getString("influxdb.token"); + String org = config.getString("influxdb.org"); + String bucket = config.getString("influxdb.bucket"); + + if (url == null || token == null || org == null || bucket == null) { + log.error("InfluxDB configuration is missing"); + return; + } + + InfluxDBClientOptions options = InfluxDBClientOptions.builder() + .url(url) + .authenticateToken(token.toCharArray()) + .org(org) + .bucket(bucket) + .build(); + + try { + influxDB = InfluxDBClientFactory.create(options); + influxDB.ping(); // test the connection + writeApi = influxDB.getWriteApiBlocking(); + } catch (Exception e) { + log.error("Failed to connect to influx", e); + return; + } + + // system metrics + registerMetric(new CpuUsageMetric()); + + // world metrics + registerMetric(new WorldSizeMetric()); + + // server metrics + registerMetric(new TpsMetric()); + registerMetric(new MemoryMetric()); + registerMetric(new PlayerCountMetric()); + registerMetric(new TotalJoinsMetric()); + + Bukkit.getAsyncScheduler().runAtFixedRate(Aetheria.INSTANCE, (task) -> this.collectMetrics(), 30, 30, TimeUnit.SECONDS); + } + + /** + * Collect all metrics and write them to influx + */ + public void collectMetrics() { + log.info("Collecting metrics"); + long before = System.currentTimeMillis(); + List points = new ArrayList<>(); + for (Metric metric : metrics) { + points.add(metric.toPoint()); + } + // write the points async + Aetheria.EXECUTOR.execute(() -> { + writeApi.writePoints(points, new WriteParameters(WritePrecision.MS, WriteConsistency.ONE)); + + log.info("Wrote {} points to influx ({}ms)", points.size(), System.currentTimeMillis() - before); + }); + } + + /** + * Register a new metric + * + * @param metric the metric to register + */ + public static void registerMetric(Metric metric) { + metrics.add(metric); + } + + @EventHandler + public void onPluginDisable(PluginDisableEvent event) { + if (event.getPlugin() != Aetheria.INSTANCE) { + return; + } + influxDB.close(); // close the connection + } +} diff --git a/src/main/java/cc/fascinated/metrics/impl/server/MemoryMetric.java b/src/main/java/cc/fascinated/metrics/impl/server/MemoryMetric.java new file mode 100644 index 0000000..955facd --- /dev/null +++ b/src/main/java/cc/fascinated/metrics/impl/server/MemoryMetric.java @@ -0,0 +1,21 @@ +package cc.fascinated.metrics.impl.server; + +import cc.fascinated.metrics.Metric; +import com.influxdb.client.write.Point; + +public class MemoryMetric extends Metric { + + public MemoryMetric() { + super("memory"); + } + + @Override + protected Point toPoint() { + Runtime runtime = Runtime.getRuntime(); + + return Point.measurement(getName()) + .addField("total", runtime.totalMemory()) + .addField("available", runtime.freeMemory()) + .addField("used", runtime.totalMemory() - runtime.freeMemory()); + } +} diff --git a/src/main/java/cc/fascinated/metrics/impl/server/PlayerCountMetric.java b/src/main/java/cc/fascinated/metrics/impl/server/PlayerCountMetric.java new file mode 100644 index 0000000..5e5e9f2 --- /dev/null +++ b/src/main/java/cc/fascinated/metrics/impl/server/PlayerCountMetric.java @@ -0,0 +1,18 @@ +package cc.fascinated.metrics.impl.server; + +import cc.fascinated.metrics.Metric; +import com.influxdb.client.write.Point; +import org.bukkit.Bukkit; + +public class PlayerCountMetric extends Metric { + + public PlayerCountMetric() { + super("player_count"); + } + + @Override + protected Point toPoint() { + return Point.measurement(getName()) + .addField("value", Bukkit.getServer().getOnlinePlayers().size()); + } +} diff --git a/src/main/java/cc/fascinated/metrics/impl/server/TotalJoinsMetric.java b/src/main/java/cc/fascinated/metrics/impl/server/TotalJoinsMetric.java new file mode 100644 index 0000000..e1a81f7 --- /dev/null +++ b/src/main/java/cc/fascinated/metrics/impl/server/TotalJoinsMetric.java @@ -0,0 +1,18 @@ +package cc.fascinated.metrics.impl.server; + +import cc.fascinated.metrics.Metric; +import com.influxdb.client.write.Point; +import org.bukkit.Bukkit; + +public class TotalJoinsMetric extends Metric { + + public TotalJoinsMetric() { + super("total_joins"); + } + + @Override + protected Point toPoint() { + return Point.measurement(getName()) + .addField("value", Bukkit.getServer().getOfflinePlayers().length); + } +} diff --git a/src/main/java/cc/fascinated/metrics/impl/server/TpsMetric.java b/src/main/java/cc/fascinated/metrics/impl/server/TpsMetric.java new file mode 100644 index 0000000..323834d --- /dev/null +++ b/src/main/java/cc/fascinated/metrics/impl/server/TpsMetric.java @@ -0,0 +1,19 @@ +package cc.fascinated.metrics.impl.server; + +import cc.fascinated.metrics.Metric; +import com.influxdb.client.write.Point; +import org.bukkit.Bukkit; + +public class TpsMetric extends Metric { + + public TpsMetric() { + super("tps"); + } + + @Override + protected Point toPoint() { + return Point.measurement("tps") + .addTag("server", "server") + .addField("tps", Bukkit.getServer().getTPS()[0]); + } +} diff --git a/src/main/java/cc/fascinated/metrics/impl/system/CpuUsageMetric.java b/src/main/java/cc/fascinated/metrics/impl/system/CpuUsageMetric.java new file mode 100644 index 0000000..71aed58 --- /dev/null +++ b/src/main/java/cc/fascinated/metrics/impl/system/CpuUsageMetric.java @@ -0,0 +1,22 @@ +package cc.fascinated.metrics.impl.system; + +import cc.fascinated.Oshi; +import cc.fascinated.metrics.Metric; +import com.influxdb.client.write.Point; +import oshi.hardware.HardwareAbstractionLayer; + +public class CpuUsageMetric extends Metric { + + public CpuUsageMetric() { + super("cpu_usage"); + } + + @Override + protected Point toPoint() { + HardwareAbstractionLayer hardware = Oshi.SYSTEM_INFO.getHardware(); + double cpuLoad = hardware.getProcessor().getSystemCpuLoad(500) * 100; // get the CPU load in percentage + + return Point.measurement(getName()) + .addField("value", cpuLoad); + } +} diff --git a/src/main/java/cc/fascinated/metrics/impl/world/WorldSizeMetric.java b/src/main/java/cc/fascinated/metrics/impl/world/WorldSizeMetric.java new file mode 100644 index 0000000..570e210 --- /dev/null +++ b/src/main/java/cc/fascinated/metrics/impl/world/WorldSizeMetric.java @@ -0,0 +1,29 @@ +package cc.fascinated.metrics.impl.world; + +import cc.fascinated.metrics.Metric; +import cc.fascinated.worldsize.WorldSizeManager; +import com.influxdb.client.write.Point; +import org.bukkit.World; + +import java.util.Map; + +public class WorldSizeMetric extends Metric { + + public WorldSizeMetric() { + super("world_size"); + } + + @Override + protected Point toPoint() { + Map worldSizes = WorldSizeManager.getWorldSizes(); + if (worldSizes.isEmpty()) { + return null; + } + + Point point = Point.measurement(getName()); + for (Map.Entry entry : worldSizes.entrySet()) { + point.addField(entry.getKey().getName(), entry.getValue()); + } + return point; + } +} diff --git a/src/main/java/cc/fascinated/placeholder/AetheriaPlaceholder.java b/src/main/java/cc/fascinated/placeholder/AetheriaPlaceholder.java new file mode 100644 index 0000000..737256b --- /dev/null +++ b/src/main/java/cc/fascinated/placeholder/AetheriaPlaceholder.java @@ -0,0 +1,31 @@ +package cc.fascinated.placeholder; + +import org.bukkit.entity.Player; + +import javax.annotation.Nullable; + +public interface AetheriaPlaceholder { + + /** + * @return the identifier for this placeholder + */ + String getIdentifier(); + + /** + * Parse this placeholder and return the value for the provided player + * + * @param player the player to parse the placeholder for, null if offline + * @param params the parameters for the placeholder + * @return the placeholder string + */ + String parse(@Nullable Player player, String[] params); + + /** + * Return the required amount of parameters for this placeholder + * Does not include the expansion identifier or the placeholder identifier + * + * @return the required amount of parameters + */ + int getRequiredParameterCount(); + +} \ No newline at end of file diff --git a/src/main/java/cc/fascinated/placeholder/PlaceholderManager.java b/src/main/java/cc/fascinated/placeholder/PlaceholderManager.java new file mode 100644 index 0000000..8470313 --- /dev/null +++ b/src/main/java/cc/fascinated/placeholder/PlaceholderManager.java @@ -0,0 +1,106 @@ +package cc.fascinated.placeholder; + +import cc.fascinated.Aetheria; +import lombok.extern.log4j.Log4j2; +import me.clip.placeholderapi.PlaceholderAPI; +import me.clip.placeholderapi.expansion.PlaceholderExpansion; +import org.bukkit.OfflinePlayer; +import org.bukkit.entity.Player; +import org.jetbrains.annotations.NotNull; +import org.jetbrains.annotations.Nullable; + +import java.util.Arrays; +import java.util.Map; +import java.util.concurrent.ConcurrentHashMap; + +@Log4j2 +public class PlaceholderManager { + + private static final Map PLACEHOLDERS = new ConcurrentHashMap<>(); + + public PlaceholderManager() { + new PlaceholderAdapter().register(); + } + + /** + * Register the provided placeholder + * + * @param placeholder the placeholder to register + */ + public static void registerPlaceholder(AetheriaPlaceholder placeholder) { + PLACEHOLDERS.put(placeholder.getIdentifier(), placeholder); + log.info("Registered placeholder " + placeholder.getIdentifier()); + } + + /** + * Unregister the provided placeholder + * + * @param placeholder the placeholder to unregister + */ + public static void unregisterPlaceholder(AetheriaPlaceholder placeholder) { + PLACEHOLDERS.remove(placeholder.getIdentifier()); + log.info("Unregistered placeholder " + placeholder.getIdentifier()); + } + + /** + * Replace PAPI placeholders in the given content. + * + * @param player the player to replace the placeholders for, null if offline + * @param content the content to replace the placeholders in + * @return the content with the placeholders replaced + */ + public static String replace(@Nullable Player player, String content) { + return PlaceholderAPI.setPlaceholders(player != null && (player.isOnline()) ? player : null, content); + } + + static class PlaceholderAdapter extends PlaceholderExpansion { + + @Override + public @NotNull String getIdentifier() { + return "aetheria"; + } + + @SuppressWarnings("UnstableApiUsage") + @Override + public @NotNull String getAuthor() { + return String.join(", ", Aetheria.INSTANCE.getPluginMeta().getAuthors()); + } + + @SuppressWarnings("UnstableApiUsage") + @Override + public @NotNull String getVersion() { + return Aetheria.INSTANCE.getPluginMeta().getVersion(); + } + + /** + * From PlaceholderAPI: + *

+ * Expansions that do not use the e-cloud and instead register from the dependency should set this to true + * to ensure that your placeholder expansion is not unregistered when the papi reload command is used + */ + public boolean persist() { + return true; + } + + @Override + public @Nullable String onRequest(@Nullable OfflinePlayer player, @NotNull String params) { + String[] parameters = params.split("_"); + AetheriaPlaceholder placeholder = PLACEHOLDERS.get(parameters[0]); + // Attempt to fetch the placeholder with the provided id + if (placeholder == null) { + log.error("Tried to fetch an unregistered placeholder: " + parameters[0]); + return null; + } + // Ensure the correct amount of parameters is provided + if (parameters.length - 1 < placeholder.getRequiredParameterCount()) { + log.error("Invalid placeholders provided for {}, provided = {}, required = {}", + placeholder.getIdentifier(), + parameters.length - 1, + placeholder.getRequiredParameterCount()); + return null; + } + // Trim the placeholder identifier from the parameters before parsing + return placeholder.parse((Player) player, parameters.length > 1 ? Arrays.copyOfRange(parameters, 1, parameters.length) : parameters); + } + } +} \ No newline at end of file diff --git a/src/main/java/cc/fascinated/worldsize/WorldSizeManager.java b/src/main/java/cc/fascinated/worldsize/WorldSizeManager.java index 07b0671..9011e8b 100644 --- a/src/main/java/cc/fascinated/worldsize/WorldSizeManager.java +++ b/src/main/java/cc/fascinated/worldsize/WorldSizeManager.java @@ -2,6 +2,7 @@ package cc.fascinated.worldsize; import cc.fascinated.Aetheria; import cc.fascinated.command.CommandManager; +import cc.fascinated.placeholder.PlaceholderManager; import cc.fascinated.worldsize.impl.WorldSizeCommand; import lombok.Getter; import org.bukkit.Bukkit; @@ -31,6 +32,7 @@ public class WorldSizeManager { public WorldSizeManager() { CommandManager.registerCommand(new WorldSizeCommand()); + PlaceholderManager.registerPlaceholder(new WorldSizePlaceholder()); Aetheria.INSTANCE.getServer().getAsyncScheduler().runAtFixedRate(Aetheria.INSTANCE, (task) -> { calculateTotalWorldSize(); diff --git a/src/main/java/cc/fascinated/worldsize/WorldSizePlaceholder.java b/src/main/java/cc/fascinated/worldsize/WorldSizePlaceholder.java new file mode 100644 index 0000000..e9e8db8 --- /dev/null +++ b/src/main/java/cc/fascinated/worldsize/WorldSizePlaceholder.java @@ -0,0 +1,31 @@ +package cc.fascinated.worldsize; + +import cc.fascinated.placeholder.AetheriaPlaceholder; +import cc.fascinated.utils.FormatterUtils; +import org.bukkit.Bukkit; +import org.bukkit.World; +import org.bukkit.entity.Player; +import org.jetbrains.annotations.Nullable; + +public class WorldSizePlaceholder implements AetheriaPlaceholder { + + @Override + public String getIdentifier() { + return "worldsize"; + } + + @Override + public String parse(@Nullable Player player, String[] params) { + World world = Bukkit.getWorld(params[0].replaceAll("-", "_")); + if (world == null) { + return "-1"; + } + long size = WorldSizeManager.getWorldSizes().get(world); + return FormatterUtils.formatBytes(size); + } + + @Override + public int getRequiredParameterCount() { + return 1; + } +} diff --git a/src/main/resources/config.yml b/src/main/resources/config.yml index a1ed6ee..e540806 100644 --- a/src/main/resources/config.yml +++ b/src/main/resources/config.yml @@ -1,3 +1,9 @@ +influxdb: + url: "http://localhost:8086" + token: "aetheria" + org: "aetheria" + bucket: "aetheria" + help-command: - "&e/help &7- &fShows this help message" - "&e/kill &7- &fKills you" diff --git a/src/main/resources/plugin.yml b/src/main/resources/plugin.yml index d7ae89c..d26c4f8 100644 --- a/src/main/resources/plugin.yml +++ b/src/main/resources/plugin.yml @@ -1,6 +1,9 @@ name: Aetheria main: cc.fascinated.Aetheria version: 1.0 +author: Fascinated +depend: + - PlaceholderAPI commands: totaljoins: description: "Shows the total amount of joins"