Created
March 24, 2018 13:40
-
-
Save Bastian/6d59583dbc891f1c0426919443b75f4e to your computer and use it in GitHub Desktop.
This Metrics class is a special creation for the "other" category.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
package org.bstats; | |
import org.json.simple.JSONArray; | |
import org.json.simple.JSONObject; | |
import javax.net.ssl.HttpsURLConnection; | |
import java.io.BufferedReader; | |
import java.io.ByteArrayOutputStream; | |
import java.io.DataOutputStream; | |
import java.io.IOException; | |
import java.io.InputStream; | |
import java.io.InputStreamReader; | |
import java.net.URL; | |
import java.util.ArrayList; | |
import java.util.List; | |
import java.util.Map; | |
import java.util.Timer; | |
import java.util.TimerTask; | |
import java.util.concurrent.Callable; | |
import java.util.logging.Level; | |
import java.util.logging.Logger; | |
import java.util.zip.GZIPOutputStream; | |
/** | |
* bStats collects some data for plugin authors. | |
* | |
* Check out https://bStats.org/ to learn more about bStats! | |
*/ | |
public class Metrics { | |
// The version of this bStats class | |
public static final int B_STATS_VERSION = 1; | |
// The url to which the data is sent | |
private static final String URL = "https://bStats.org/submitData/other"; | |
// Should failed requests be logged? | |
private static boolean logFailedRequests = false; | |
// Should the sent data be logged? | |
private static boolean logSentData; | |
// Should the response text be logged? | |
private static boolean logResponseStatusText; | |
// The logger for the failed requests | |
private static Logger logger = Logger.getLogger("bStats"); | |
// The name of the server software | |
private final String name; | |
// The uuid of the server | |
private final String serverUUID; | |
// A list with all custom charts | |
private final List<CustomChart> charts = new ArrayList<>(); | |
/** | |
* Class constructor. | |
* | |
* @param name The name of the server software. | |
* @param serverUUID The uuid of the server. | |
* @param logFailedRequests Whether failed requests should be logged or not. | |
* @param logSentData Whether the sent data should be logged or not. | |
* @param logResponseStatusText Whether the response text should be logged or not. | |
*/ | |
public Metrics(String name, String serverUUID, boolean logFailedRequests, boolean logSentData, boolean logResponseStatusText) { | |
this.name = name; | |
this.serverUUID = serverUUID; | |
Metrics.logFailedRequests = logFailedRequests; | |
Metrics.logSentData = logSentData; | |
Metrics.logResponseStatusText = logResponseStatusText; | |
Metrics.logger = logger; | |
// Start submitting the data | |
startSubmitting(); | |
} | |
/** | |
* Adds a custom chart. | |
* | |
* @param chart The chart to add. | |
*/ | |
public void addCustomChart(CustomChart chart) { | |
if (chart == null) { | |
throw new IllegalArgumentException("Chart cannot be null!"); | |
} | |
charts.add(chart); | |
} | |
/** | |
* Starts the Scheduler which submits our data every 30 minutes. | |
*/ | |
private void startSubmitting() { | |
final Timer timer = new Timer(true); | |
timer.scheduleAtFixedRate(new TimerTask() { | |
@Override | |
public void run() { | |
submitData(); | |
} | |
}, 1000*60*5, 1000*60*30); | |
// Submit the data every 30 minutes, first time after 5 minutes to give other plugins enough time to start | |
// WARNING: Changing the frequency has no effect but your plugin WILL be blocked/deleted! | |
// WARNING: Just don't do it! | |
} | |
/** | |
* Gets the plugin specific data. | |
* | |
* @return The plugin specific data. | |
*/ | |
private JSONObject getPluginData() { | |
JSONObject data = new JSONObject(); | |
data.put("pluginName", name); // Append the name of the server software | |
JSONArray customCharts = new JSONArray(); | |
for (CustomChart customChart : charts) { | |
// Add the data of the custom charts | |
JSONObject chart = customChart.getRequestJsonObject(); | |
if (chart == null) { // If the chart is null, we skip it | |
continue; | |
} | |
customCharts.add(chart); | |
} | |
data.put("customCharts", customCharts); | |
return data; | |
} | |
/** | |
* Gets the server specific data. | |
* | |
* @return The server specific data. | |
*/ | |
private JSONObject getServerData() { | |
JSONObject data = new JSONObject(); | |
data.put("serverUUID", serverUUID); | |
return data; | |
} | |
/** | |
* Collects the data and sends it afterwards. | |
*/ | |
private void submitData() { | |
final JSONObject data = getServerData(); | |
JSONArray pluginData = new JSONArray(); | |
pluginData.add(getPluginData()); | |
data.put("plugins", pluginData); | |
try { | |
// We are still in the Thread of the timer, so nothing get blocked :) | |
sendData(data); | |
} catch (Exception e) { | |
// Something went wrong! :( | |
if (logFailedRequests) { | |
logger.log(Level.WARNING, "Could not submit stats of " + name, e); | |
} | |
} | |
} | |
/** | |
* Sends the data to the bStats server. | |
* | |
* @param data The data to send. | |
* @throws Exception If the request failed. | |
*/ | |
private static void sendData(JSONObject data) throws Exception { | |
if (data == null) { | |
throw new IllegalArgumentException("Data cannot be null!"); | |
} | |
if (logSentData) { | |
logger.log(Level.INFO, "Sending data to bStats: " + data.toString()); | |
} | |
HttpsURLConnection connection = (HttpsURLConnection) new URL(URL).openConnection(); | |
// Compress the data to save bandwidth | |
byte[] compressedData = compress(data.toString()); | |
// Add headers | |
connection.setRequestMethod("POST"); | |
connection.addRequestProperty("Accept", "application/json"); | |
connection.addRequestProperty("Connection", "close"); | |
connection.addRequestProperty("Content-Encoding", "gzip"); // We gzip our request | |
connection.addRequestProperty("Content-Length", String.valueOf(compressedData.length)); | |
connection.setRequestProperty("Content-Type", "application/json"); // We send our data in JSON format | |
connection.setRequestProperty("User-Agent", "MC-Server/" + B_STATS_VERSION); | |
// Send data | |
connection.setDoOutput(true); | |
DataOutputStream outputStream = new DataOutputStream(connection.getOutputStream()); | |
outputStream.write(compressedData); | |
outputStream.flush(); | |
outputStream.close(); | |
InputStream inputStream = connection.getInputStream(); | |
BufferedReader bufferedReader = new BufferedReader(new InputStreamReader(inputStream)); | |
StringBuilder builder = new StringBuilder(); | |
String line; | |
while ((line = bufferedReader.readLine()) != null) { | |
builder.append(line); | |
} | |
bufferedReader.close(); | |
if (logResponseStatusText) { | |
logger.log(Level.INFO, "Sent data to bStats and received response: " + builder.toString()); | |
} | |
} | |
/** | |
* Gzips the given String. | |
* | |
* @param str The string to gzip. | |
* @return The gzipped String. | |
* @throws IOException If the compression failed. | |
*/ | |
private static byte[] compress(final String str) throws IOException { | |
if (str == null) { | |
return null; | |
} | |
ByteArrayOutputStream outputStream = new ByteArrayOutputStream(); | |
GZIPOutputStream gzip = new GZIPOutputStream(outputStream); | |
gzip.write(str.getBytes("UTF-8")); | |
gzip.close(); | |
return outputStream.toByteArray(); | |
} | |
/** | |
* Represents a custom chart. | |
*/ | |
public static abstract class CustomChart { | |
// The id of the chart | |
final String chartId; | |
/** | |
* Class constructor. | |
* | |
* @param chartId The id of the chart. | |
*/ | |
CustomChart(String chartId) { | |
if (chartId == null || chartId.isEmpty()) { | |
throw new IllegalArgumentException("ChartId cannot be null or empty!"); | |
} | |
this.chartId = chartId; | |
} | |
private JSONObject getRequestJsonObject() { | |
JSONObject chart = new JSONObject(); | |
chart.put("chartId", chartId); | |
try { | |
JSONObject data = getChartData(); | |
if (data == null) { | |
// If the data is null we don't send the chart. | |
return null; | |
} | |
chart.put("data", data); | |
} catch (Throwable t) { | |
if (logFailedRequests) { | |
logger.log(Level.WARNING, "Failed to get data for custom chart with id " + chartId, t); | |
} | |
return null; | |
} | |
return chart; | |
} | |
protected abstract JSONObject getChartData() throws Exception; | |
} | |
/** | |
* Represents a custom simple pie. | |
*/ | |
public static class SimplePie extends CustomChart { | |
private final Callable<String> callable; | |
/** | |
* Class constructor. | |
* | |
* @param chartId The id of the chart. | |
* @param callable The callable which is used to request the chart data. | |
*/ | |
public SimplePie(String chartId, Callable<String> callable) { | |
super(chartId); | |
this.callable = callable; | |
} | |
@Override | |
protected JSONObject getChartData() throws Exception { | |
JSONObject data = new JSONObject(); | |
String value = callable.call(); | |
if (value == null || value.isEmpty()) { | |
// Null = skip the chart | |
return null; | |
} | |
data.put("value", value); | |
return data; | |
} | |
} | |
/** | |
* Represents a custom advanced pie. | |
*/ | |
public static class AdvancedPie extends CustomChart { | |
private final Callable<Map<String, Integer>> callable; | |
/** | |
* Class constructor. | |
* | |
* @param chartId The id of the chart. | |
* @param callable The callable which is used to request the chart data. | |
*/ | |
public AdvancedPie(String chartId, Callable<Map<String, Integer>> callable) { | |
super(chartId); | |
this.callable = callable; | |
} | |
@Override | |
protected JSONObject getChartData() throws Exception { | |
JSONObject data = new JSONObject(); | |
JSONObject values = new JSONObject(); | |
Map<String, Integer> map = callable.call(); | |
if (map == null || map.isEmpty()) { | |
// Null = skip the chart | |
return null; | |
} | |
boolean allSkipped = true; | |
for (Map.Entry<String, Integer> entry : map.entrySet()) { | |
if (entry.getValue() == 0) { | |
continue; // Skip this invalid | |
} | |
allSkipped = false; | |
values.put(entry.getKey(), entry.getValue()); | |
} | |
if (allSkipped) { | |
// Null = skip the chart | |
return null; | |
} | |
data.put("values", values); | |
return data; | |
} | |
} | |
/** | |
* Represents a custom drilldown pie. | |
*/ | |
public static class DrilldownPie extends CustomChart { | |
private final Callable<Map<String, Map<String, Integer>>> callable; | |
/** | |
* Class constructor. | |
* | |
* @param chartId The id of the chart. | |
* @param callable The callable which is used to request the chart data. | |
*/ | |
public DrilldownPie(String chartId, Callable<Map<String, Map<String, Integer>>> callable) { | |
super(chartId); | |
this.callable = callable; | |
} | |
@Override | |
public JSONObject getChartData() throws Exception { | |
JSONObject data = new JSONObject(); | |
JSONObject values = new JSONObject(); | |
Map<String, Map<String, Integer>> map = callable.call(); | |
if (map == null || map.isEmpty()) { | |
// Null = skip the chart | |
return null; | |
} | |
boolean reallyAllSkipped = true; | |
for (Map.Entry<String, Map<String, Integer>> entryValues : map.entrySet()) { | |
JSONObject value = new JSONObject(); | |
boolean allSkipped = true; | |
for (Map.Entry<String, Integer> valueEntry : map.get(entryValues.getKey()).entrySet()) { | |
value.put(valueEntry.getKey(), valueEntry.getValue()); | |
allSkipped = false; | |
} | |
if (!allSkipped) { | |
reallyAllSkipped = false; | |
values.put(entryValues.getKey(), value); | |
} | |
} | |
if (reallyAllSkipped) { | |
// Null = skip the chart | |
return null; | |
} | |
data.put("values", values); | |
return data; | |
} | |
} | |
/** | |
* Represents a custom single line chart. | |
*/ | |
public static class SingleLineChart extends CustomChart { | |
private final Callable<Integer> callable; | |
/** | |
* Class constructor. | |
* | |
* @param chartId The id of the chart. | |
* @param callable The callable which is used to request the chart data. | |
*/ | |
public SingleLineChart(String chartId, Callable<Integer> callable) { | |
super(chartId); | |
this.callable = callable; | |
} | |
@Override | |
protected JSONObject getChartData() throws Exception { | |
JSONObject data = new JSONObject(); | |
int value = callable.call(); | |
if (value == 0) { | |
// Null = skip the chart | |
return null; | |
} | |
data.put("value", value); | |
return data; | |
} | |
} | |
/** | |
* Represents a custom multi line chart. | |
*/ | |
public static class MultiLineChart extends CustomChart { | |
private final Callable<Map<String, Integer>> callable; | |
/** | |
* Class constructor. | |
* | |
* @param chartId The id of the chart. | |
* @param callable The callable which is used to request the chart data. | |
*/ | |
public MultiLineChart(String chartId, Callable<Map<String, Integer>> callable) { | |
super(chartId); | |
this.callable = callable; | |
} | |
@Override | |
protected JSONObject getChartData() throws Exception { | |
JSONObject data = new JSONObject(); | |
JSONObject values = new JSONObject(); | |
Map<String, Integer> map = callable.call(); | |
if (map == null || map.isEmpty()) { | |
// Null = skip the chart | |
return null; | |
} | |
boolean allSkipped = true; | |
for (Map.Entry<String, Integer> entry : map.entrySet()) { | |
if (entry.getValue() == 0) { | |
continue; // Skip this invalid | |
} | |
allSkipped = false; | |
values.put(entry.getKey(), entry.getValue()); | |
} | |
if (allSkipped) { | |
// Null = skip the chart | |
return null; | |
} | |
data.put("values", values); | |
return data; | |
} | |
} | |
/** | |
* Represents a custom simple bar chart. | |
*/ | |
public static class SimpleBarChart extends CustomChart { | |
private final Callable<Map<String, Integer>> callable; | |
/** | |
* Class constructor. | |
* | |
* @param chartId The id of the chart. | |
* @param callable The callable which is used to request the chart data. | |
*/ | |
public SimpleBarChart(String chartId, Callable<Map<String, Integer>> callable) { | |
super(chartId); | |
this.callable = callable; | |
} | |
@Override | |
protected JSONObject getChartData() throws Exception { | |
JSONObject data = new JSONObject(); | |
JSONObject values = new JSONObject(); | |
Map<String, Integer> map = callable.call(); | |
if (map == null || map.isEmpty()) { | |
// Null = skip the chart | |
return null; | |
} | |
for (Map.Entry<String, Integer> entry : map.entrySet()) { | |
JSONArray categoryValues = new JSONArray(); | |
categoryValues.add(entry.getValue()); | |
values.put(entry.getKey(), categoryValues); | |
} | |
data.put("values", values); | |
return data; | |
} | |
} | |
/** | |
* Represents a custom advanced bar chart. | |
*/ | |
public static class AdvancedBarChart extends CustomChart { | |
private final Callable<Map<String, int[]>> callable; | |
/** | |
* Class constructor. | |
* | |
* @param chartId The id of the chart. | |
* @param callable The callable which is used to request the chart data. | |
*/ | |
public AdvancedBarChart(String chartId, Callable<Map<String, int[]>> callable) { | |
super(chartId); | |
this.callable = callable; | |
} | |
@Override | |
protected JSONObject getChartData() throws Exception { | |
JSONObject data = new JSONObject(); | |
JSONObject values = new JSONObject(); | |
Map<String, int[]> map = callable.call(); | |
if (map == null || map.isEmpty()) { | |
// Null = skip the chart | |
return null; | |
} | |
boolean allSkipped = true; | |
for (Map.Entry<String, int[]> entry : map.entrySet()) { | |
if (entry.getValue().length == 0) { | |
continue; // Skip this invalid | |
} | |
allSkipped = false; | |
JSONArray categoryValues = new JSONArray(); | |
for (int categoryValue : entry.getValue()) { | |
categoryValues.add(categoryValue); | |
} | |
values.put(entry.getKey(), categoryValues); | |
} | |
if (allSkipped) { | |
// Null = skip the chart | |
return null; | |
} | |
data.put("values", values); | |
return data; | |
} | |
} | |
} |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment