Upstream/Paper
1
0
Fork 0
mirror of https://github.com/PaperMC/Paper.git synced 2025-01-31 12:41:25 +01:00
Code Issues Projects Releases Wiki Activity

8948: Nag when timings is enabled or a plugin creates a new Timing

Browse Source
This commit is contained in:
Riley Park 2023-03-29 12:11:36 -07:00
parent 7c76b259a5
commit 90a88fcc04
1 changed files with 14 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
patches/api/Timings-v2.patch
View File

@ -1320,6 +1320,7 @@ index 0000000000000000000000000000000000000000..00000000000000000000000000000000
+ static boolean verboseEnabled = false;
+ private static int historyInterval = -1;
+ private static int historyLength = -1;
+ private static boolean warnedAboutDeprecationOnEnable;
+
+ private Timings() {}
+
@ -1354,6 +1355,7 @@ index 0000000000000000000000000000000000000000..00000000000000000000000000000000
+ @NotNull
+ public static Timing of(@NotNull Plugin plugin, @NotNull String name, @Nullable Timing groupHandler) {
+ Preconditions.checkNotNull(plugin, "Plugin can not be null");
+ Bukkit.getLogger().warning(String.format("Plugin '%s' is creating timing '%s' - this is deprecated behavior, please report it to the authors: %s", plugin.getName(), name, String.join(", ", plugin.getDescription().getAuthors())));
+ return TimingsManager.getHandler(plugin.getName(), name, groupHandler);
+ }
+
@ -1410,9 +1412,21 @@ index 0000000000000000000000000000000000000000..00000000000000000000000000000000
+ */
+ public static void setTimingsEnabled(boolean enabled) {
+ timingsEnabled = enabled;
+ warnAboutDeprecationOnEnable();
+ reset();
+ }
+
+ private static void warnAboutDeprecationOnEnable() {
+ if (timingsEnabled && !warnedAboutDeprecationOnEnable) {
+ Bukkit.getLogger().warning(String.join("\n",
+ "[!] The timings system has been enabled but has been scheduled for removal from Paper in the future.",
+ " We recommend installing the spark profiler as a replacement: https://spark.lucko.me/",
+ " For more information please visit: https://github.com/PaperMC/Paper/issues/8948"
+ ));
+ warnedAboutDeprecationOnEnable = true;
+ }
+ }
+
+ /**
+ * <p>Sets whether or not the Timings should monitor at Verbose level.</p>
+ *