Upstream/Plan
1
0
Fork 0
mirror of https://github.com/plan-player-analytics/Plan.git synced 2025-01-01 05:57:50 +01:00
Code Issues Projects Releases Wiki Activity

Debug information page for easier bug reporting

Browse Source
This commit is contained in:
Rsl1122 2017-11-13 16:26:31 +02:00
parent 5b91374fc1
commit 5162f70e0c
5 changed files with 190 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
Plan/src/main/java/com/djrapitops/plan/systems/info/BukkitInformationManager.java
View File

@ -4,6 +4,7 @@
*/
package main.java.com.djrapitops.plan.systems.info;
import com.djrapitops.plugin.api.utility.log.ErrorLogger;
import com.djrapitops.plugin.api.utility.log.Log;
import main.java.com.djrapitops.plan.Plan;
import main.java.com.djrapitops.plan.Settings;
@ -30,6 +31,7 @@ import main.java.com.djrapitops.plan.utilities.MiscUtils;
import main.java.com.djrapitops.plan.utilities.analysis.Analysis;
import main.java.com.djrapitops.plan.utilities.html.HtmlStructure;
import java.io.IOException;
import java.io.Serializable;
import java.sql.SQLException;
import java.util.*;
@ -344,4 +346,9 @@ public class BukkitInformationManager extends InformationManager {
}
}
}
@Override
public TreeMap<String, List<String>> getErrors() throws IOException {
return ErrorLogger.getLoggedErrors(plugin);
}
}

8
Plan/src/main/java/com/djrapitops/plan/systems/info/BungeeInformationManager.java
View File

@ -4,6 +4,7 @@
*/
package main.java.com.djrapitops.plan.systems.info;
import com.djrapitops.plugin.api.utility.log.ErrorLogger;
import com.djrapitops.plugin.api.utility.log.Log;
import main.java.com.djrapitops.plan.PlanBungee;
import main.java.com.djrapitops.plan.api.exceptions.ParseException;
@ -25,6 +26,7 @@ import main.java.com.djrapitops.plan.systems.webserver.webapi.bungee.RequestPlug
import main.java.com.djrapitops.plan.utilities.MiscUtils;
import main.java.com.djrapitops.plan.utilities.html.HtmlStructure;
import java.io.IOException;
import java.sql.SQLException;
import java.util.*;
import java.util.function.Function;
@ -362,4 +364,10 @@ public class BungeeInformationManager extends InformationManager {
online.stream().map(ServerInfo::getUuid)
.forEach(serverInfoManager::sendConfigSettings);
}
@Override
public TreeMap<String, List<String>> getErrors() throws IOException {
// TODO Request Bukkit servers for errors
return ErrorLogger.getLoggedErrors(plugin);
}
}

3
Plan/src/main/java/com/djrapitops/plan/systems/info/InformationManager.java
View File

@ -9,6 +9,7 @@ import main.java.com.djrapitops.plan.systems.cache.DataCache;
import main.java.com.djrapitops.plan.systems.cache.SessionCache;
import main.java.com.djrapitops.plan.systems.webserver.PageCache;
import java.io.IOException;
import java.util.*;
/**
@ -84,4 +85,6 @@ public abstract class InformationManager {
public abstract void analysisReady(UUID serverUUID);
public abstract void updateNetworkPageContent();
public abstract TreeMap<String,List<String>> getErrors() throws IOException;
}

2
Plan/src/main/java/com/djrapitops/plan/systems/webserver/ResponseHandler.java
View File

@ -78,6 +78,8 @@ public class ResponseHandler extends APIResponseHandler {
String page = args[1];
switch (page) {
case "debug":
return new DebugPageResponse();
case "players":
return PageCache.loadPage("players", PlayersPageResponse::new);
case "player":

170
Plan/src/main/java/com/djrapitops/plan/systems/webserver/response/DebugPageResponse.java Normal file
View File

@ -0,0 +1,170 @@
/*
* Licence is provided in the jar as license.yml also here:
* https://github.com/Rsl1122/Plan-PlayerAnalytics/blob/master/Plan/src/main/resources/license.yml
*/
package main.java.com.djrapitops.plan.systems.webserver.response;
import com.djrapitops.plugin.api.Benchmark;
import com.djrapitops.plugin.api.Check;
import com.djrapitops.plugin.api.utility.log.Log;
import main.java.com.djrapitops.plan.PlanBungee;
import main.java.com.djrapitops.plan.ServerVariableHolder;
import main.java.com.djrapitops.plan.api.IPlan;
import main.java.com.djrapitops.plan.systems.info.server.BungeeServerInfoManager;
import main.java.com.djrapitops.plan.systems.info.server.ServerInfo;
import main.java.com.djrapitops.plan.utilities.MiscUtils;
import main.java.com.djrapitops.plan.utilities.file.FileUtil;
import main.java.com.djrapitops.plan.utilities.html.Html;
import java.io.File;
import java.io.IOException;
import java.nio.charset.Charset;
import java.sql.SQLException;
import java.util.*;
/**
* WebServer response for /debug-page used for easing issue reporting.
*
* @author Rsl1122
*/
public class DebugPageResponse extends ErrorResponse {
public DebugPageResponse() {
super.setHeader("HTTP/1.1 200 OK");
super.setTitle("Debug Information");
super.setParagraph(buildParagraph());
replacePlaceholders();
}
private String buildParagraph() {
StringBuilder content = new StringBuilder();
String issueLink = Html.LINK_EXTERNAL.parse("https://github.com/Rsl1122/Plan-PlayerAnalytics/issues/new", "Create new issue on Github");
// Information
content.append("<p>")
.append(issueLink).append("<br><br>")
.append("This page contains debug information for an issue ticket.<br>You can copy it directly into the issue, the info is pre-formatted.")
.append("</p>");
appendServerInformation(content);
if (Check.isBungeeAvailable()) {
appendBungeeConfiguration(content);
}
appendLoggedErrors(content);
appendDebugLog(content);
appendBenchmarks(content);
appendConfig(content);
return content.toString();
}
private void appendServerInformation(StringBuilder content) {
IPlan plugin = MiscUtils.getIPlan();
ServerVariableHolder variable = plugin.getVariable();
content.append("<pre>### Server Information<br>")
.append("**Plan Version:** ").append(plugin.getVersion()).append("<br>");
content.append("**Server:** ");
content.append(variable.getName())
.append(" ").append(variable.getImplVersion())
.append(" ").append(variable.getVersion());
content.append("<br>");
content.append("**Database:** ").append(plugin.getDB().getName());
try {
content.append(" schema v").append(plugin.getDB().getVersion());
} catch (SQLException e) {
Log.toLog(this.getClass().getName(), e);
}
content.append("</pre>");
}
private void appendConfig(StringBuilder content) {
try {
File configFile = new File(MiscUtils.getIPlan().getDataFolder(), "config.yml");
if (configFile.exists()) {
content.append("<pre>### config.yml<br>&#96;&#96;&#96;<br>");
FileUtil.lines(configFile, Charset.forName("UTF-8"))
.stream().filter(line -> line.toLowerCase().contains("pass"))
.forEach(line -> content.append(line).append("<br>"));
content.append("&#96;&#96;&#96;</pre>");
}
} catch (IOException e) {
Log.toLog(this.getClass().getName(), e);
}
}
private void appendBungeeConfiguration(StringBuilder content) {
PlanBungee plugin = PlanBungee.getInstance();
BungeeServerInfoManager serverInfoManager = plugin.getServerInfoManager();
Collection<ServerInfo> online = serverInfoManager.getOnlineBukkitServers();
Collection<ServerInfo> bukkitServers = serverInfoManager.getBukkitServers();
content.append("<pre>### Bungee Configuration<br>");
content.append("Server name | Online | Address | UUID<br>")
.append("-- | -- | -- | --<br>");
for (ServerInfo info : bukkitServers) {
content.append(info.getName()).append(" | ")
.append(online.contains(info) ? "Online" : "Offline").append(" | ")
.append(info.getWebAddress()).append(" | ")
.append(info.getUuid()).append("<br>");
}
content.append("</pre>");
}
private void appendBenchmarks(StringBuilder content) {
content.append("<pre>### Benchmarks<br>&#96;&#96;&#96;<br>");
for (String line : Benchmark.getAverages().asStringArray()) {
content.append(line).append("<br>");
}
content.append("&#96;&#96;&#96;</pre>");
}
private void appendLoggedErrors(StringBuilder content) {
try {
content.append("<pre>### Logged Errors<br>");
TreeMap<String, List<String>> errors = MiscUtils.getIPlan().getInfoManager().getErrors();
if (!errors.isEmpty()) {
List<String> errorLines = new ArrayList<>();
for (Map.Entry<String, List<String>> entry : errors.entrySet()) {
StringBuilder errorLineBuilder = new StringBuilder();
for (String line : entry.getValue()) {
errorLineBuilder.append(line).append("<br>");
}
String error = errorLineBuilder.toString();
if (!errorLines.contains(error)) {
errorLines.add(error);
}
}
for (String error : errorLines) {
content.append("&#96;&#96;&#96;<br>")
.append(error)
.append("&#96;&#96;&#96;<br>")
.append("- [ ] Fixed<br>");
}
} else {
content.append("**No Errors logged.**<br>");
}
content.append("</pre>");
} catch (IOException e) {
Log.toLog(this.getClass().getName(), e);
}
}
private void appendDebugLog(StringBuilder content) {
content.append("<pre>### Debug Log<br>&#96;&#96;&#96;<br>");
for (String line : Log.getDebugLogInMemory()) {
content.append(line).append("<br>");
}
content.append("&#96;&#96;&#96;</pre>");
}
}