Add option in MetricsBase to disable relocate check

While being enabled in all of the "normal" Metrics classes, some server implementations also use the MetricBase. When they ensure that it does not share a class loader with their plugins, the relocate check is not necessary.
Bastian · Jul 28, 2024 · 184ceb9 · 184ceb9
1 parent e8d3b1c
commit 184ceb9
Show file tree

Hide file tree

Showing 6 changed files with 16 additions and 7 deletions.
diff --git a/base/src/main/java/org/bstats/MetricsBase.java b/base/src/main/java/org/bstats/MetricsBase.java
@@ -80,6 +80,8 @@ public class MetricsBase {
      *                                    logged.
      * @param logResponseStatusText       Whether or not the response status text
      *                                    should be logged.
+     * @param skipRelocateCheck           Whether or not the relocate check should be
+     *                                    skipped.
      */
     public MetricsBase(
             String platform,
@@ -94,7 +96,8 @@ public MetricsBase(
             Consumer<String> infoLogger,
             boolean logErrors,
             boolean logSentData,
-            boolean logResponseStatusText) {
+            boolean logResponseStatusText,
+            boolean skipRelocateCheck) {
         ScheduledThreadPoolExecutor scheduler = new ScheduledThreadPoolExecutor(1,
                 task -> {
                     Thread thread = new Thread(task, "bStats-Metrics");
@@ -122,7 +125,9 @@ public MetricsBase(
         this.logSentData = logSentData;
         this.logResponseStatusText = logResponseStatusText;
 
-        checkRelocation();
+        if (!skipRelocateCheck) {
+            checkRelocation();
+        }
 
         if (enabled) { // WARNING: Removing the option to opt-out will get your plugin banned from
                        // bStats

diff --git a/base/src/test/java/org/bstats/RelocateCheckTest.java b/base/src/test/java/org/bstats/RelocateCheckTest.java
@@ -25,7 +25,7 @@ public void shouldRespectDisabledRelocateCheck() {
     }
 
     private MetricsBase createDummyMetricsBase() {
-        return new MetricsBase("", "", -1, false, null, null, null, null, null, null, true, true, true);
+        return new MetricsBase("", "", -1, false, null, null, null, null, null, null, true, true, true, false);
     }
 
 }
diff --git a/bukkit/src/main/java/org/bstats/bukkit/Metrics.java b/bukkit/src/main/java/org/bstats/bukkit/Metrics.java
@@ -76,7 +76,8 @@ public Metrics(JavaPlugin plugin, int serviceId) {
                 (message) -> this.plugin.getLogger().log(Level.INFO, message),
                 logErrors,
                 logSentData,
-                logResponseStatusText
+                logResponseStatusText,
+                false
         );
     }
 

diff --git a/bungeecord/src/main/java/org/bstats/bungeecord/Metrics.java b/bungeecord/src/main/java/org/bstats/bungeecord/Metrics.java
@@ -58,7 +58,8 @@ public Metrics(Plugin plugin, int serviceId) {
                 (message) -> this.plugin.getLogger().log(Level.INFO, message),
                 logErrors,
                 logSentData,
-                logResponseStatusText
+                logResponseStatusText,
+                false
         );
     }
 

diff --git a/sponge/src/main/java/org/bstats/sponge/Metrics.java b/sponge/src/main/java/org/bstats/sponge/Metrics.java
@@ -103,7 +103,8 @@ public void startup(ConstructPluginEvent event) {
                 logger::info,
                 logErrors,
                 logSentData,
-                logResponseStatusText
+                logResponseStatusText,
+                false
         );
 
         StringBuilder builder = new StringBuilder().append(System.lineSeparator());

diff --git a/velocity/src/main/java/org/bstats/velocity/Metrics.java b/velocity/src/main/java/org/bstats/velocity/Metrics.java
@@ -81,7 +81,8 @@ private Metrics(Object plugin, ProxyServer server, Logger logger, Path dataDirec
                 logger::info,
                 config.isLogErrorsEnabled(),
                 config.isLogSentDataEnabled(),
-                config.isLogResponseStatusTextEnabled()
+                config.isLogResponseStatusTextEnabled(),
+                false
         );
 
         if (!config.didExistBefore()) {