Merge pull request #21 from renvins/dev/fabric

Impelement fabric support

Author: renvins

.github/workflows/ci.yml

@@ -3,9 +3,9 @@ name: CI Build and Infrastructure Check
 # Controls when the workflow will run
 on:
   push:
-    branches: [ master ] # Or your default branch (e.g., master)
+    branches: [master] # Or your default branch (e.g., master)
   pull_request:
-    branches: [ master ] # Or your default branch
+    branches: [master] # Or your default branch
 
 jobs:
   # Job to build the plugin and test Docker infrastructure
@@ -37,6 +37,9 @@ jobs:
       - name: Build JAR files
         run: ./gradlew shadowJar
 
+      - name: Build Fabric JAR
+        run: ./gradlew fabric:build
+
       # Upload Bukkit JAR as an artifact
       - name: Upload Bukkit JAR Artifact
         uses: actions/upload-artifact@v4
@@ -55,6 +58,15 @@ jobs:
           retention-days: 14 # Keep artifacts for 14 days
           if-no-files-found: error # Fail the workflow if no JARs are found
 
+      # Upload Fabric JAR as an artifact
+      - name: Upload Fabric JAR Artifact
+        uses: actions/upload-artifact@v4
+        with:
+          name: serverpulse-fabric-jar
+          path: fabric/build/libs/serverpulse-*.jar
+          retention-days: 14 # Keep artifacts for 14 days
+          if-no-files-found: error # Fail the workflow if no JARs are found
+
       # --- Infrastructure Testing ---
 
       # 4. Install jq (needed for parsing InfluxDB health check JSON)

.github/workflows/create_release.yml

@@ -33,9 +33,12 @@ jobs:
         uses: gradle/actions/setup-gradle@v4 # Use v4 or latest stable version
 
       # Gradle with the new updates doesn't support arguments
-      - name: Build jar
+      - name: Build Bukkit and Velocity jar
         run: ./gradlew shadowJar
 
+      - name: Build fabric jar
+        run: ./gradlew fabric:build
+
       # 5. Find the Bukkit Shadow Jar file and extract its name
       - name: Find Bukkit Shadow Jar and Extract Name
         id: find_bukkit_jar
@@ -68,7 +71,23 @@ jobs:
           echo "filename=$JAR_FILENAME" >> $GITHUB_OUTPUT
         shell: bash
 
-      # 7. Upload the Bukkit Shadow Jar as a release asset
+      # 7. Find the Fabric Jar file and extract its name
+      - name: Find Fabric Jar and Extract Name
+        id: find_fabric_jar
+        run: |
+          JAR_PATH=$(find fabric/build/libs -maxdepth 1 -name 'serverpulse-*.jar' -printf "%s %p\n" | sort -nr | head -n 1 | awk '{print $2}')
+          if [ -z "$JAR_PATH" ]; then
+            echo "Error: Could not find the shadow JAR file in fabric/build/libs/"
+            exit 1
+          fi
+          JAR_FILENAME=$(basename "$JAR_PATH")
+          echo "Found JAR path: $JAR_PATH"
+          echo "Found JAR filename: $JAR_FILENAME"
+          echo "path=$JAR_PATH" >> $GITHUB_OUTPUT
+          echo "filename=$JAR_FILENAME" >> $GITHUB_OUTPUT
+        shell: bash
+
+      # 8. Upload the Bukkit Shadow Jar as a release asset
       - name: Upload Bukkit Release Asset
         uses: svenstaro/upload-release-action@v2
         with:
@@ -78,12 +97,22 @@ jobs:
           tag: ${{ github.ref }} # The git tag associated with the release that triggered the workflow
           overwrite: true # Optional: Replace asset with the same name if it already exists
 
-      # 8. Upload the Velocity Shadow Jar as a release asset
+      # 9. Upload the Velocity Shadow Jar as a release asset
       - name: Upload Velocity Release Asset
         uses: svenstaro/upload-release-action@v2
         with:
           repo_token: ${{ secrets.GITHUB_TOKEN }} # Provided by GitHub Actions automatically
           file: ${{ steps.find_velocity_jar.outputs.path }} # The path to the JAR found in the previous step
           asset_name: ${{ steps.find_velocity_jar.outputs.filename }} # Use the filename extracted earlier
           tag: ${{ github.ref }} # The git tag associated with the release that triggered the workflow
+          overwrite: true # Optional: Replace asset with the same name if it already exists
+
+      # 10. Upload the Fabric Jar as a release asset
+      - name: Upload Fabric Release Asset
+        uses: svenstaro/upload-release-action@v2
+        with:
+          repo_token: ${{ secrets.GITHUB_TOKEN }} # Provided by GitHub Actions automatically
+          file: ${{ steps.find_fabric_jar.outputs.path }} # The path to the JAR found in the previous step
+          asset_name: ${{ steps.find_fabric_jar.outputs.filename }} # Use the filename extracted earlier
+          tag: ${{ github.ref }} # The git tag associated with the release that triggered the workflow
           overwrite: true # Optional: Replace asset with the same name if it already exists

README.md

@@ -22,18 +22,19 @@ ServerPulse is an **open-source**, real-time performance monitoring tool for Min
 
 - **Goal:** Provide an extensible, lightweight plugin to gather server metrics and store them in InfluxDB for visualization with Grafana.
 - **Tech stack:**
-    - Java (plugin) → InfluxDB
+    - Java (plugin/mod) → InfluxDB
     - Grafana dashboard (preconfigured via provisioning)
     - Discord alerts for key server metrics
     - Docker Compose (for InfluxDB & Grafana setup)
 
 ## 🌟 Platform Support
 
-ServerPulse now supports **all Minecraft server platforms** in the Bukkit/Paper ecosystem:
+ServerPulse now supports **all Minecraft server platforms** in the ecosystem:
 
 - **Bukkit/Spigot**: Full support with custom TPS monitoring implementation
 - **Paper and its forks** (Purpur, Pufferfish, etc.): Enhanced support with native TPS monitoring
 - **Velocity**: Support for Velocity proxy servers (ofc TPS and world metrics are not available)
+- **Fabric**: Support for Fabric servers (latest versions of Fabric API and Minecraft)
 
 The plugin automatically detects your server platform and uses the most efficient implementation available for that environment.
 
@@ -42,7 +43,7 @@ The plugin automatically detects your server platform and uses the most efficien
 ServerPulse isn't just another metrics exporter - it offers several unique advantages:
 
 - **Complete Monitoring Stack** - Fully integrated solution with InfluxDB (optimized for time-series data) and pre-configured Grafana dashboards
-- **Universal Platform Support** - Works with any Bukkit-based and Velocity server while taking advantage of Paper-specific optimizations when available
+- **Universal Platform Support** - Works with any Bukkit-based, Velocity and Fabric server while taking advantage of Paper-specific optimizations when available
 - **Per-World Analytics** - Track entity counts, chunk loading, and performance metrics separately for each world
 - **Flexible Tagging System** - Group and filter metrics by server, network, region, or any custom dimension through simple configuration
 - **Zero-Configuration Dashboards** - Auto-provisioned Grafana dashboards - no manual setup required
@@ -64,17 +65,17 @@ The wiki contains comprehensive documentation on:
 
 ## 📊 Comparison with Alternative Solutions
 
-| Feature | ServerPulse | Generic Prometheus Exporters |
-|---------|------------|--------------------------|
-| Setup Time | ~5 minutes with Docker Compose | Manual metrics + Prometheus + Grafana setup |
-| Dashboard Configuration | Pre-configured, auto-provisioned | Manual dashboard creation |
+| Feature | ServerPulse                          | Generic Prometheus Exporters |
+|---------|--------------------------------------|--------------------------|
+| Setup Time | ~5 minutes with Docker Compose       | Manual metrics + Prometheus + Grafana setup |
+| Dashboard Configuration | Pre-configured, auto-provisioned     | Manual dashboard creation |
 | Data Storage | InfluxDB (optimized for time-series) | Prometheus (general-purpose) |
-| Platform Support | All Bukkit-based servers | Varies by implementation |
-| Per-World Metrics | Built-in | Usually not available |
-| Custom Tagging | Flexible tag system | Limited labeling |
-| Alert System | Discord and Telegram integration | Requires manual setup |
-| Infrastructure | Complete stack included | Manual integration required |
-| Health Monitoring | Automated health checks | Varies by implementation |
+| Platform Support | All Minecraft Servers                | Varies by implementation |
+| Per-World Metrics | Built-in                             | Usually not available |
+| Custom Tagging | Flexible tag system                  | Limited labeling |
+| Alert System | Discord and Telegram integration     | Requires manual setup |
+| Infrastructure | Complete stack included              | Manual integration required |
+| Health Monitoring | Automated health checks              | Varies by implementation |
 
 ## 🤝 Contributing
 

api/src/main/java/it/renvins/serverpulse/api/data/SyncMetricsSnapshot.java

@@ -2,6 +2,7 @@
 
 import java.util.Map;
 
+
 public class SyncMetricsSnapshot {
 
     private final double[] tps;

api/src/main/java/it/renvins/serverpulse/api/data/WorldData.java

@@ -1,5 +1,9 @@
 package it.renvins.serverpulse.api.data;
 
+/**
+ * Represents data about a world in the server.
+ * This class contains information about the number of entities and loaded chunks in a world.
+ */
 public class WorldData {
 
     private final int entities;

build.gradle.kts

@@ -1,5 +1,5 @@
 group = "it.renvins"
-version = "0.2.5-SNAPSHOT"
+version = "0.3.0-SNAPSHOT"
 
 repositories {
     mavenCentral()

bukkit/build.gradle.kts

@@ -28,7 +28,7 @@ java {
     toolchain.languageVersion.set(JavaLanguageVersion.of(21))
 }
 
-val relocatePath = "it.renvins.serverpulse.libs"
+val relocatePath = "it.renvins.serverpulse.bukkit.libs"
 
 tasks.withType<ShadowJar> {
     archiveBaseName = "serverpulse"

bukkit/src/main/java/it/renvins/serverpulse/bukkit/ServerPulseBukkitLoader.java

@@ -25,6 +25,8 @@
 import it.renvins.serverpulse.bukkit.platform.BukkitPlatform;
 import it.renvins.serverpulse.bukkit.scheduler.BukkitTaskScheduler;
 import it.renvins.serverpulse.common.MetricsService;
+import it.renvins.serverpulse.common.platform.Platform;
+import it.renvins.serverpulse.common.scheduler.TaskScheduler;
 
 public class ServerPulseBukkitLoader implements Service {
 
@@ -33,6 +35,8 @@ public class ServerPulseBukkitLoader implements Service {
 
     private final BukkitConfiguration config;
 
+    private final Platform platform;
+
     private final IDatabaseService databaseService;
     private final IMetricsService metricsService;
 
@@ -48,8 +52,8 @@ public ServerPulseBukkitLoader(ServerPulseBukkit plugin) {
 
         PulseLogger logger = new BukkitLogger(LOGGER);
 
-        BukkitPlatform platform = new BukkitPlatform(plugin);
-        BukkitTaskScheduler taskScheduler = new BukkitTaskScheduler(plugin);
+        this.platform = new BukkitPlatform(plugin);
+        TaskScheduler taskScheduler = new BukkitTaskScheduler(plugin);
 
         DatabaseConfiguration databaseConfiguration = new BukkitDatabaseConfiguration(config);
         MetricsConfiguration metricsConfiguration = new BukkitMetricsConfiguration(config);
@@ -64,23 +68,19 @@ public ServerPulseBukkitLoader(ServerPulseBukkit plugin) {
         }
         this.diskRetriever = new DiskRetriever(plugin.getDataFolder());
         this.pingRetriever = new BukkitPingRetriever();
+
+        LOGGER.info("ServerPulse for Bukkit/Paper initialized - waiting for server starting...");
     }
 
     @Override
     public void load() {
         LOGGER.info("Loading configuration...");
         config.load();
 
-        if(!config.getConfig().getBoolean("metrics.enabled")) {
-            LOGGER.severe("Shutting down the plugin because metrics are disabled!");
-            plugin.getServer().getPluginManager().disablePlugin(plugin);
-
-            return;
-        }
         ServerPulseProvider.register(new ServerPulseBukkitAPI(databaseService, metricsService, tpsRetriever, diskRetriever, pingRetriever));
 
         databaseService.load();
-        if (!plugin.isEnabled()) {
+        if (!platform.isEnabled()) {
             return;
         }
         metricsService.load();

bukkit/src/main/java/it/renvins/serverpulse/bukkit/config/BukkitConfiguration.java

@@ -16,21 +16,11 @@ public class BukkitConfiguration {
     private File file;
     @Getter private YamlConfiguration config;
 
-    /**
-     * Constructs a new CustomConfig manager.
-     *
-     * @param plugin The main ServerPulsePlugin instance.
-     * @param name   The name of the configuration file (e.g., "config.yml").
-     */
     public BukkitConfiguration(ServerPulseBukkit plugin, String name) {
         this.plugin = plugin;
         this.name = name;
     }
 
-    /**
-     * Loads the configuration file. If the file doesn't exist,
-     * it saves the default resource from the plugin JAR.
-     */
     public void load() {
         if (!plugin.getDataFolder().exists()) {
             plugin.getDataFolder().mkdir();
@@ -42,10 +32,6 @@ public void load() {
         config = YamlConfiguration.loadConfiguration(file);
     }
 
-    /**
-     * Saves the current configuration state back to the file.
-     * Logs an error if saving fails.
-     */
     public void save() {
         try {
             config.save(file);
@@ -54,12 +40,6 @@ public void save() {
         }
     }
 
-    /**
-     * Reloads the configuration file, reloading the YamlConfiguration.
-     * Logs an error if the file is null.
-     *
-     * @return true if the reload was successful, false otherwise.
-     */
     public boolean reload() {
         if (file == null) {
             ServerPulseBukkitLoader.LOGGER.log(Level.SEVERE, "File is null, cannot reload configuration.");

bukkit/src/main/java/it/renvins/serverpulse/bukkit/metrics/BukkitTPSRetriever.java

@@ -55,7 +55,7 @@ public void run() {
         }.runTaskTimer(plugin, 1L, 1L);
     }
     private void calculateAverages() {
-        long sum1m = 0, sum5m = 0, sum15m = 0;
+        double sum1m = 0, sum5m = 0, sum15m = 0;
         int count1m = 0, count5m = 0, count15m = 0;
 
         int i = 0;
@@ -87,7 +87,7 @@ private void calculateAverages() {
         tps15m = calculateTPSFromAvgNano(sum15m, count15m);
     }
 
-    private double calculateTPSFromAvgNano(long totalNano, int count) {
+    private double calculateTPSFromAvgNano(double totalNano, int count) {
         if (count == 0) {
             return 20.0;
         }

bukkit/src/main/java/it/renvins/serverpulse/bukkit/platform/BukkitPlatform.java

@@ -23,7 +23,7 @@ public boolean isEnabled() {
 
     @Override
     public void disable() {
-        plugin.getServer().getPluginManager().disablePlugin(plugin);
+        plugin.getServer().shutdown();
     }
 
     @Override

bukkit/src/main/java/it/renvins/serverpulse/bukkit/scheduler/BukkitTaskScheduler.java

@@ -18,27 +18,17 @@ public void runSync(Runnable task) {
     }
 
     @Override
-    public void runAsync(Runnable task) {
-        plugin.getServer().getScheduler().runTaskAsynchronously(plugin, task);
+    public void runTaskTimer(Runnable task, long delayTicks, long periodTicks) {
+        plugin.getServer().getScheduler().runTaskTimer(plugin, task, delayTicks, periodTicks);
     }
 
     @Override
-    public Task runTaskTimer(Runnable task, long delayTicks, long periodTicks) {
-        return new BukkitTaskWrapper(plugin.getServer().getScheduler().runTaskTimer(plugin, task, delayTicks, periodTicks));
+    public void runAsync(Runnable task) {
+        plugin.getServer().getScheduler().runTaskAsynchronously(plugin, task);
     }
 
     @Override
     public Task runTaskTimerAsync(Runnable task, long delayTicks, long periodTicks) {
         return new BukkitTaskWrapper(plugin.getServer().getScheduler().runTaskTimerAsynchronously(plugin, task, delayTicks, periodTicks));
     }
-
-    @Override
-    public Task runTaskLater(Runnable task, long delayTicks) {
-        return new BukkitTaskWrapper(plugin.getServer().getScheduler().runTaskLater(plugin, task, delayTicks));
-    }
-
-    @Override
-    public Task runTaskLaterAsync(Runnable task, long delayTicks) {
-        return new BukkitTaskWrapper(plugin.getServer().getScheduler().runTaskLaterAsynchronously(plugin, task, delayTicks));
-    }
 }

bukkit/src/main/resources/config.yml

@@ -1,5 +1,4 @@
 metrics:
-  enabled: true
   interval: 5
   influxdb:
     url: http://localhost:8086 # The URL of the InfluxDB API

common/src/main/java/it/renvins/serverpulse/common/DatabaseService.java

@@ -56,7 +56,7 @@ public DatabaseService(PulseLogger logger, Platform platform, DatabaseConfigurat
     @Override
     public void load() {
         if (!checkConnectionData()) {
-            logger.error("InfluxDB connection data is missing or invalid. Disabling plugin...");
+            logger.error("InfluxDB connection data is missing or invalid. Shutting down...");
             platform.disable();
             return;
         }
@@ -66,6 +66,7 @@ public void load() {
 
     @Override
     public void unload() {
+        logger.info("Unloading InfluxDB connection...");
         stopRetryTask(); // Stop retries before disconnecting
         disconnect();
         if (httpClient != null) {

common/src/main/java/it/renvins/serverpulse/common/platform/Platform.java

@@ -13,8 +13,11 @@ public interface Platform {
 
     /**
      * Disable the plugin
+     * @throws UnsupportedOperationException if the platform does not support this method
      */
-    void disable();
+    default void disable() {
+        throw new UnsupportedOperationException("This method is not supported on this platform.");
+    }
 
     /**
      * @return true if the current thread is the main thread of the server