cn.nukkit.metrics.NukkitMetrics Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of powernukkit Show documentation
Show all versions of powernukkit Show documentation
A Minecraft Bedrock Edition server software implementation made in Java from scratch which supports all new features.
package cn.nukkit.metrics;
import cn.nukkit.Player;
import cn.nukkit.Server;
import cn.nukkit.api.DeprecationDetails;
import cn.nukkit.api.PowerNukkitOnly;
import cn.nukkit.api.Since;
import cn.nukkit.utils.Config;
import cn.nukkit.utils.LoginChainData;
import lombok.extern.log4j.Log4j2;
import javax.annotation.Nonnull;
import java.io.BufferedWriter;
import java.io.File;
import java.io.FileWriter;
import java.io.IOException;
import java.util.*;
import java.util.concurrent.Callable;
import java.util.concurrent.atomic.AtomicReference;
import java.util.regex.Matcher;
import java.util.regex.Pattern;
import static cn.nukkit.utils.NukkitCollectors.countingInt;
import static java.util.stream.Collectors.groupingBy;
@Since("1.4.0.0-PN")
@Log4j2
public class NukkitMetrics {
private static final AtomicReference> metricsStarted = new AtomicReference<>(Collections.emptyMap());
private final Server server;
private boolean enabled;
private String serverUUID;
private boolean logFailedRequests;
private Metrics metrics;
/**
* Setup the nukkit metrics and starts it if it hadn't started yet.
*
* @param server The Nukkit server
* @deprecated Replace with {@link #startNow(Server)}
*/
@SuppressWarnings({"DeprecatedIsStillUsed", "java:S1133"})
@Deprecated
@DeprecationDetails(by = "PowerNukkit", since = "1.4.0.0-PN", replaceWith = "NukkitMetrics.startNow(Server)",
reason = "The original cloudburst nukkit constructor implementation behaves like a stateful static method " +
"and don't comply with Java standards. Use the static method startNow(server) instead.")
@Since("1.4.0.0-PN") public NukkitMetrics(Server server) {
this(server, true);
}
private NukkitMetrics(Server server, boolean start) {
this.server = server;
try {
this.loadConfig();
} catch (Exception e) {
log.warn("Failed to load the bStats configuration file", e);
}
if (start && enabled) {
startNow(server);
}
}
/**
* Setup the nukkit metrics and starts it if it hadn't started yet.
*
* @param server The Nukkit server
*/
@PowerNukkitOnly @Since("1.4.0.0-PN")
public static boolean startNow(Server server) {
NukkitMetrics nukkitMetrics = getOrCreateMetrics(server);
return nukkitMetrics.metrics != null;
}
private static NukkitMetrics getOrCreateMetrics(@Nonnull final Server server) {
Map current = metricsStarted.get();
NukkitMetrics metrics = current.get(server);
if (metrics != null) {
return metrics;
}
current = metricsStarted.updateAndGet(before -> {
Map mutable = before;
if (before.isEmpty()) {
mutable = new WeakHashMap<>(1);
}
mutable.computeIfAbsent(server, NukkitMetrics::createMetrics);
return mutable;
});
metrics = current.get(server);
assert metrics != null;
return metrics;
}
@Nonnull
private static NukkitMetrics createMetrics(@Nonnull final Server server) {
NukkitMetrics nukkitMetrics = new NukkitMetrics(server, false);
if (!nukkitMetrics.enabled) {
return nukkitMetrics;
}
final Metrics metrics = new Metrics("Nukkit", nukkitMetrics.serverUUID, nukkitMetrics.logFailedRequests);
nukkitMetrics.metrics = metrics;
metrics.addCustomChart(new Metrics.SingleLineChart("players", () -> server.getOnlinePlayers().size()));
metrics.addCustomChart(new Metrics.SimplePie("codename", server::getCodename));
metrics.addCustomChart(new Metrics.SimplePie("minecraft_version", server::getVersion));
metrics.addCustomChart(new Metrics.SimplePie("nukkit_version", server::getNukkitVersion));
metrics.addCustomChart(new Metrics.SimplePie("xbox_auth", () -> server.getPropertyBoolean("xbox-auth") ? "Required" : "Not required"));
metrics.addCustomChart(new Metrics.AdvancedPie("player_platform", () -> server.getOnlinePlayers().values().stream()
.map(Player::getLoginChainData)
.map(LoginChainData::getDeviceOS)
.collect(groupingBy(nukkitMetrics::mapDeviceOSToString, countingInt()))));
metrics.addCustomChart(new Metrics.AdvancedPie("player_game_version", () -> server.getOnlinePlayers().values().stream()
.map(Player::getLoginChainData)
.collect(groupingBy(LoginChainData::getGameVersion, countingInt()))));
metrics.addCustomChart(new Metrics.DrilldownPie("java_version", new JavaVersionRetriever()));
return nukkitMetrics;
}
private static class JavaVersionRetriever implements Callable>> {
// The following code can be attributed to the PaperMC project
// https://github.com/PaperMC/Paper/blob/master/Spigot-Server-Patches/0005-Paper-Metrics.patch#L614
@Override
public Map> call() {
Map> map = new HashMap<>();
String javaVersion = System.getProperty("java.version");
Map entry = new HashMap<>();
entry.put(javaVersion, 1);
// http://openjdk.java.net/jeps/223
// Java decided to change their versioning scheme and in doing so modified the java.version system
// property to return $major[.$minor][.$secuity][-ea], as opposed to 1.$major.0_$identifier
// we can handle pre-9 by checking if the "major" is equal to "1", otherwise, 9+
String majorVersion = javaVersion.split("\\.")[0];
String release;
int indexOf = javaVersion.lastIndexOf('.');
if (majorVersion.equals("1")) {
release = "Java " + javaVersion.substring(0, indexOf);
} else {
// of course, it really wouldn't be all that simple if they didn't add a quirk, now would it
// valid strings for the major may potentially include values such as -ea to deannotate a pre release
Matcher versionMatcher = Pattern.compile("\\d+").matcher(majorVersion);
if (versionMatcher.find()) {
majorVersion = versionMatcher.group(0);
}
release = "Java " + majorVersion;
}
map.put(release, entry);
return map;
}
}
/**
* Loads the bStats configuration.
*/
private void loadConfig() throws IOException {
File bStatsFolder = new File(server.getPluginPath(), "bStats");
if (!bStatsFolder.exists() && !bStatsFolder.mkdirs()) {
log.warn("Failed to create bStats metrics directory");
return;
}
File configFile = new File(bStatsFolder, "config.yml");
if (!configFile.exists()) {
writeFile(configFile,
"# bStats collects some data for plugin authors like how many servers are using their plugins.",
"# To honor their work, you should not disable it.",
"# This has nearly no effect on the server performance!",
"# Check out https://bStats.org/ to learn more :)",
"enabled: true",
"serverUuid: \"" + UUID.randomUUID().toString() + "\"",
"logFailedRequests: false");
}
Config config = new Config(configFile, Config.YAML);
// Load configuration
this.enabled = config.getBoolean("enabled", true);
this.serverUUID = config.getString("serverUuid");
this.logFailedRequests = config.getBoolean("logFailedRequests", false);
}
private void writeFile(File file, String... lines) throws IOException {
try (BufferedWriter writer = new BufferedWriter(new FileWriter(file))) {
for (String line : lines) {
writer.write(line);
writer.newLine();
}
}
}
private String mapDeviceOSToString(int os) {
switch (os) {
case 1: return "Android";
case 2: return "iOS";
case 3: return "macOS";
case 4: return "FireOS";
case 5: return "Gear VR";
case 6: return "Hololens";
case 7: return "Windows 10";
case 8: return "Windows";
case 9: return "Dedicated";
case 10: return "PS4";
case 11:
case 12: return "Switch";
case 13: return "Xbox One";
case 14: return "Windows Phone";
default: return "Unknown";
}
}
}