Merge pull request #18 from renvins/dev/velocity

Implement velocity module and provisioned dashboards

Author: renvins

.github/workflows/ci.yml

@@ -33,16 +33,25 @@ jobs:
       - name: Setup Gradle and Build Plugin Jar
         uses: gradle/actions/setup-gradle@v4 # Use v4 or latest stable version
 
-      # Gradle with the new updates doesn't support arguments
-      - name: Build jar
+      # Build both Bukkit and Velocity JARs
+      - name: Build JAR files
         run: ./gradlew shadowJar
 
-      # Upload JAR as an artifact (NEW STEP)
-      - name: Upload JAR Artifact
+      # Upload Bukkit JAR as an artifact
+      - name: Upload Bukkit JAR Artifact
         uses: actions/upload-artifact@v4
         with:
-          name: plugin-jar
-          path: bukkit/build/libs/*.jar # Adjust this path to match your JAR location
+          name: serverpulse-bukkit-jar
+          path: bukkit/build/libs/*.jar
+          retention-days: 14 # Keep artifacts for 14 days
+          if-no-files-found: error # Fail the workflow if no JARs are found
+
+      # Upload Velocity JAR as an artifact
+      - name: Upload Velocity JAR Artifact
+        uses: actions/upload-artifact@v4
+        with:
+          name: serverpulse-velocity-jar
+          path: velocity/build/libs/*.jar
           retention-days: 14 # Keep artifacts for 14 days
           if-no-files-found: error # Fail the workflow if no JARs are found
 
@@ -53,7 +62,6 @@ jobs:
         run: sudo apt-get update && sudo apt-get install -y jq
 
       # 5. Start Docker Compose services in detached mode
-      # Replace 'path/to/your/docker-compose.yml' if it's not in the root
       - name: Start Docker Infrastructure
         run: docker compose -f infra/docker-compose.yml up -d
 

.github/workflows/create_release.yml

@@ -1,4 +1,4 @@
-name: Create Release Asset
+name: Create Release Assets
 
 # Trigger the workflow only when a release is published
 on:
@@ -36,9 +36,9 @@ jobs:
       - name: Build jar
         run: ./gradlew shadowJar
 
-      # 5. Find the specific Shadow Jar file and extract its name
-      - name: Find Shadow Jar and Extract Name
-        id: find_jar
+      # 5. Find the Bukkit Shadow Jar file and extract its name
+      - name: Find Bukkit Shadow Jar and Extract Name
+        id: find_bukkit_jar
         run: |
           JAR_PATH=$(find bukkit/build/libs -maxdepth 1 -name '*.jar' -printf "%s %p\n" | sort -nr | head -n 1 | awk '{print $2}')
           if [ -z "$JAR_PATH" ]; then
@@ -52,12 +52,38 @@ jobs:
           echo "filename=$JAR_FILENAME" >> $GITHUB_OUTPUT
         shell: bash
 
-      # 6. Upload the Shadow Jar as a release asset
-      - name: Upload Release Asset
+      # 6. Find the Velocity Shadow Jar file and extract its name
+      - name: Find Velocity Shadow Jar and Extract Name
+        id: find_velocity_jar
+        run: |
+          JAR_PATH=$(find velocity/build/libs -maxdepth 1 -name '*.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 velocity/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
+
+      # 7. Upload the Bukkit Shadow Jar as a release asset
+      - name: Upload Bukkit Release Asset
         uses: svenstaro/upload-release-action@v2
         with:
           repo_token: ${{ secrets.GITHUB_TOKEN }} # Provided by GitHub Actions automatically
-          file: ${{ steps.find_jar.outputs.path }} # The path to the JAR found in the previous step
-          asset_name: ${{ steps.find_jar.outputs.filename }} # Use the filename extracted earlier
+          file: ${{ steps.find_bukkit_jar.outputs.path }} # The path to the JAR found in the previous step
+          asset_name: ${{ steps.find_bukkit_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
+
+      # 8. 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

README.md

@@ -13,6 +13,9 @@ ServerPulse is an **open-source**, real-time performance monitoring tool for Min
 ![ServerPulse Grafana Dashboard Example2](img/dashboard2.png)
 *Example dashboard view 2: Per-World Details*
 
+![ServerPulse Grafana Dashboard Example3](img/dashboard3.png)
+*Example dashboard view 3: Players Ping Overview*
+
 </details>
 
 ## 📖 What This Project Is
@@ -30,6 +33,7 @@ ServerPulse now supports **all Minecraft server platforms** in the Bukkit ecosys
 
 - **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)
 
 The plugin automatically detects your server platform and uses the most efficient implementation available for that environment.
 
@@ -38,7 +42,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 server while taking advantage of Paper-specific optimizations when available
+- **Universal Platform Support** - Works with any Bukkit-based and Velocity 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

api/src/main/java/it/renvins/serverpulse/api/ServerPulseAPI.java

@@ -26,8 +26,11 @@ public interface ServerPulseAPI {
      * Retrieves the instance of ITPSRetriever.
      *
      * @return The ITPSRetriever instance.
+     * @throws UnsupportedOperationException if the API implementation does not support TPS retrieval.
      */
-    ITPSRetriever getTPSRetriever();
+    default ITPSRetriever getTPSRetriever() {
+        throw new UnsupportedOperationException("TPSRetriever is not supported in this API implementation.");
+    }
 
     /**
      * Retrieves the instance of IDiskRetriever.

api/src/main/java/it/renvins/serverpulse/api/metrics/ITPSRetriever.java

@@ -2,5 +2,13 @@
 
 public interface ITPSRetriever {
 
-    double[] getTPS();
+    /**
+     * Retrieves the TPS (Ticks Per Second) of the server.
+     *
+     * @return an array of doubles representing the TPS values.
+     *         The first value is the average TPS over the last minute,
+     *         the second value is the average TPS over the last 5 minutes,
+     *         and the third value is the average TPS over the last 15 minutes.
+     */
+     double[] getTPS();
 }

build.gradle.kts

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

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

@@ -9,16 +9,18 @@
 import it.renvins.serverpulse.api.service.IDatabaseService;
 import it.renvins.serverpulse.api.service.IMetricsService;
 import it.renvins.serverpulse.api.service.Service;
+import it.renvins.serverpulse.bukkit.logger.BukkitLogger;
 import it.renvins.serverpulse.bukkit.metrics.BukkitTPSRetriever;
 import it.renvins.serverpulse.common.DatabaseService;
 import it.renvins.serverpulse.common.config.DatabaseConfiguration;
 import it.renvins.serverpulse.common.config.MetricsConfiguration;
 import it.renvins.serverpulse.bukkit.commands.ServerPulseCommand;
 import it.renvins.serverpulse.bukkit.config.BukkitConfiguration;
+import it.renvins.serverpulse.common.logger.PulseLogger;
 import it.renvins.serverpulse.common.metrics.DiskRetriever;
 import it.renvins.serverpulse.bukkit.config.BukkitDatabaseConfiguration;
 import it.renvins.serverpulse.bukkit.config.BukkitMetricsConfiguration;
-import it.renvins.serverpulse.bukkit.metrics.PingRetriever;
+import it.renvins.serverpulse.bukkit.metrics.BukkitPingRetriever;
 import it.renvins.serverpulse.bukkit.metrics.PaperTPSRetriever;
 import it.renvins.serverpulse.bukkit.platform.BukkitPlatform;
 import it.renvins.serverpulse.bukkit.scheduler.BukkitTaskScheduler;
@@ -31,9 +33,6 @@ public class ServerPulseBukkitLoader implements Service {
 
     private final BukkitConfiguration config;
 
-    private final BukkitPlatform platform;
-    private final BukkitTaskScheduler taskScheduler;
-
     private final IDatabaseService databaseService;
     private final IMetricsService metricsService;
 
@@ -47,22 +46,24 @@ public ServerPulseBukkitLoader(ServerPulseBukkit plugin) {
 
         this.config = new BukkitConfiguration(plugin, "config.yml");
 
-        this.platform = new BukkitPlatform(plugin);
-        this.taskScheduler = new BukkitTaskScheduler(plugin);
+        PulseLogger logger = new BukkitLogger(LOGGER);
+
+        BukkitPlatform platform = new BukkitPlatform(plugin);
+        BukkitTaskScheduler taskScheduler = new BukkitTaskScheduler(plugin);
 
         DatabaseConfiguration databaseConfiguration = new BukkitDatabaseConfiguration(config);
         MetricsConfiguration metricsConfiguration = new BukkitMetricsConfiguration(config);
 
-        this.databaseService = new DatabaseService(LOGGER, platform, databaseConfiguration, taskScheduler);
-        this.metricsService = new MetricsService(LOGGER, platform, metricsConfiguration, taskScheduler);
+        this.databaseService = new DatabaseService(logger, platform, databaseConfiguration, taskScheduler);
+        this.metricsService = new MetricsService(logger, platform, metricsConfiguration, taskScheduler);
 
         if (isPaper()) {
             this.tpsRetriever = new PaperTPSRetriever();
         } else {
             this.tpsRetriever = new BukkitTPSRetriever(plugin);
         }
         this.diskRetriever = new DiskRetriever(plugin.getDataFolder());
-        this.pingRetriever = new PingRetriever();
+        this.pingRetriever = new BukkitPingRetriever();
     }
 
     @Override
@@ -76,6 +77,8 @@ public void load() {
 
             return;
         }
+        ServerPulseProvider.register(new ServerPulseBukkitAPI(databaseService, metricsService, tpsRetriever, diskRetriever, pingRetriever));
+
         databaseService.load();
         if (!plugin.isEnabled()) {
             return;
@@ -88,7 +91,6 @@ public void load() {
         }
 
         plugin.getCommand("serverpulse").setExecutor(new ServerPulseCommand(config));
-        ServerPulseProvider.register(new ServerPulseBukkitAPI(databaseService, metricsService, tpsRetriever, diskRetriever, pingRetriever));
     }
 
     @Override

bukkit/src/main/java/it/renvins/serverpulse/bukkit/logger/BukkitLogger.java

@@ -0,0 +1,33 @@
+package it.renvins.serverpulse.bukkit.logger;
+
+import java.util.logging.Level;
+import java.util.logging.Logger;
+
+import it.renvins.serverpulse.common.logger.PulseLogger;
+import lombok.RequiredArgsConstructor;
+
+@RequiredArgsConstructor
+public class BukkitLogger implements PulseLogger {
+
+    private final Logger logger;
+
+    @Override
+    public void info(String message) {
+        logger.info(message);
+    }
+
+    @Override
+    public void warning(String message) {
+        logger.warning(message);
+    }
+
+    @Override
+    public void error(String message) {
+        logger.severe(message);
+    }
+
+    @Override
+    public void error(String message, Throwable throwable) {
+        logger.log(Level.SEVERE, message, throwable);
+    }
+}

bukkit/src/main/java/it/renvins/serverpulse/bukkit/metrics/PingRetriever.java renamed to bukkit/src/main/java/it/renvins/serverpulse/bukkit/metrics/BukkitPingRetriever.java

@@ -4,7 +4,7 @@
 import org.bukkit.Bukkit;
 import org.bukkit.entity.Player;
 
-public class PingRetriever implements IPingRetriever {
+public class BukkitPingRetriever implements IPingRetriever {
 
     @Override
     public int getMinPing() {