Skip to content

Loading…

Character Type Metrics #15

Merged
merged 5 commits into from

2 participants

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Commits on May 5, 2012
  1. @DMarby
  2. @DMarby

    Cleanup

    DMarby committed
Commits on May 6, 2012
  1. @DMarby

    Another Cleanup

    DMarby committed
Commits on May 7, 2012
  1. @DMarby

    Made it actually work, lawl

    DMarby committed
  2. @DMarby

    Capitalize names

    DMarby committed
This page is out of date. Refresh to see the latest.
View
29 src/main/java/net/citizensnpcs/Citizens.java
@@ -19,6 +19,7 @@
import net.citizensnpcs.api.util.NBTStorage;
import net.citizensnpcs.api.util.Storage;
import net.citizensnpcs.api.util.YamlStorage;
+import net.citizensnpcs.api.npc.character.Character;
import net.citizensnpcs.command.CommandManager;
import net.citizensnpcs.command.Injector;
import net.citizensnpcs.command.command.AdminCommands;
@@ -167,15 +168,14 @@ public void onEnable() {
if (getServer().getScheduler().scheduleSyncDelayedTask(this, new Runnable() {
@Override
public void run() {
- setupNPCs();
+ setupNPCs();
+ // Run metrics "last"
+ startMetrics();
}
}) == -1) {
Messaging.log(Level.SEVERE, "Issue enabling plugin. Disabling.");
getServer().getPluginManager().disablePlugin(this);
}
-
- // Run metrics last
- startMetrics();
}
private void startMetrics() {
@@ -183,19 +183,24 @@ private void startMetrics() {
@Override
public void run() {
try {
- Metrics metrics = new Metrics();
- metrics.addCustomData(Citizens.this, new Metrics.Plotter() {
- @Override
- public String getColumnName() {
- return "Total NPCs";
- }
-
+ Metrics metrics = new Metrics(Citizens.this);
+ metrics.addCustomData(new Metrics.Plotter("Total NPCs") {
@Override
public int getValue() {
return Iterators.size(npcManager.iterator());
}
});
- metrics.beginMeasuringPlugin(Citizens.this);
+ Metrics.Graph graph = metrics.createGraph("Character Type Usage");
+ Messaging.log("Starting Metrics");
+ for(Character character : characterManager.getRegistered()){
+ graph.addPlotter(new Metrics.Plotter(StringHelper.capitalize(character.getName())) {
+ @Override
+ public int getValue() {
+ return 1;
+ }
+ });
+ }
+ metrics.start();
} catch (IOException ex) {
Messaging.log("Unable to load metrics");
}
View
3 src/main/java/net/citizensnpcs/npc/CitizensCharacterManager.java
@@ -27,4 +27,7 @@ public void registerCharacter(CharacterFactory factory) {
ex.printStackTrace();
}
}
+ public Iterable<Character> getRegistered(){
+ return registered.values();
+ }
}
View
549 src/main/java/net/citizensnpcs/util/Metrics.java
@@ -27,6 +27,12 @@
*/
package net.citizensnpcs.util;
+import org.bukkit.Bukkit;
+import org.bukkit.configuration.file.YamlConfiguration;
+import org.bukkit.configuration.InvalidConfigurationException;
+import org.bukkit.plugin.Plugin;
+import org.bukkit.plugin.PluginDescriptionFile;
+
import java.io.BufferedReader;
import java.io.File;
import java.io.IOException;
@@ -38,26 +44,109 @@
import java.net.URLConnection;
import java.net.URLEncoder;
import java.util.Collections;
-import java.util.HashMap;
+import java.util.HashSet;
+import java.util.Iterator;
import java.util.LinkedHashSet;
-import java.util.Map;
import java.util.Set;
import java.util.UUID;
+import java.util.logging.Level;
+
+/**
+ * <p>
+ * The metrics class obtains data about a plugin and submits statistics about it to the metrics backend.
+ * </p>
+ * <p>
+ * Public methods provided by this class:
+ * </p>
+ * <code>
+ * Graph createGraph(String name); <br/>
+ * void addCustomData(Metrics.Plotter plotter); <br/>
+ * void start(); <br/>
+ * </code>
+ */
+public class Metrics {
-import org.bukkit.Bukkit;
-import org.bukkit.configuration.file.YamlConfiguration;
-import org.bukkit.plugin.Plugin;
+ /**
+ * The current revision number
+ */
+ private final static int REVISION = 5;
-public class Metrics {
+ /**
+ * The base url of the metrics domain
+ */
+ private static final String BASE_URL = "http://mcstats.org";
+
+ /**
+ * The url used to report a server's status
+ */
+ private static final String REPORT_URL = "/report/%s";
+
+ /**
+ * The file where guid and opt out is stored in
+ */
+ private static final String CONFIG_FILE = "plugins/PluginMetrics/config.yml";
+
+ /**
+ * The separator to use for custom data. This MUST NOT change unless you are hosting your own
+ * version of metrics and want to change it.
+ */
+ private static final String CUSTOM_DATA_SEPARATOR = "~~";
+
+ /**
+ * Interval of time to ping (in minutes)
+ */
+ private static final int PING_INTERVAL = 10;
+
+ /**
+ * The plugin this metrics submits for
+ */
+ private final Plugin plugin;
+
+ /**
+ * All of the custom graphs to submit to metrics
+ */
+ private final Set<Graph> graphs = Collections.synchronizedSet(new HashSet<Graph>());
+
+ /**
+ * The default graph, used for addCustomData when you don't want a specific graph
+ */
+ private final Graph defaultGraph = new Graph("Default");
+
+ /**
+ * The plugin configuration file
+ */
private final YamlConfiguration configuration;
- private final Map<Plugin, Set<Plotter>> customData = Collections
- .synchronizedMap(new HashMap<Plugin, Set<Plotter>>());
+
+ /**
+ * The plugin configuration file
+ */
+ private final File configurationFile;
+
+ /**
+ * Unique server id
+ */
private final String guid;
- public Metrics() throws IOException {
+ /**
+ * Lock for synchronization
+ */
+ private final Object optOutLock = new Object();
+
+ /**
+ * Id of the scheduled task
+ */
+ private volatile int taskId = -1;
+
+ public Metrics(final Plugin plugin) throws IOException {
+ if (plugin == null) {
+ throw new IllegalArgumentException("Plugin cannot be null");
+ }
+
+ this.plugin = plugin;
+
// load the config
- File file = new File(CONFIG_FILE);
- configuration = YamlConfiguration.loadConfiguration(file);
+ configurationFile = new File(CONFIG_FILE);
+ configuration = YamlConfiguration.loadConfiguration(configurationFile);
// add some defaults
configuration.addDefault("opt-out", false);
@@ -65,87 +154,226 @@ public Metrics() throws IOException {
// Do we need to create the file?
if (configuration.get("guid", null) == null) {
- configuration.options().header("http://metrics.griefcraft.com").copyDefaults(true);
- configuration.save(file);
+ configuration.options().header("http://mcstats.org").copyDefaults(true);
+ configuration.save(configurationFile);
}
// Load the guid then
guid = configuration.getString("guid");
}
- public void addCustomData(Plugin plugin, Plotter plotter) {
- Set<Plotter> plotters = customData.get(plugin);
-
- if (plotters == null) {
- plotters = Collections.synchronizedSet(new LinkedHashSet<Plotter>());
- customData.put(plugin, plotters);
+ /**
+ * Construct and create a Graph that can be used to separate specific plotters to their own graphs
+ * on the metrics website. Plotters can be added to the graph object returned.
+ *
+ * @param name
+ * @return Graph object created. Will never return NULL under normal circumstances unless bad parameters are given
+ */
+ public Graph createGraph(final String name) {
+ if (name == null) {
+ throw new IllegalArgumentException("Graph name cannot be null");
}
- plotters.add(plotter);
+ // Construct the graph object
+ final Graph graph = new Graph(name);
+
+ // Now we can add our graph
+ graphs.add(graph);
+
+ // and return back
+ return graph;
}
- public void beginMeasuringPlugin(final Plugin plugin) throws IOException {
- // Did we opt out?
- if (configuration.getBoolean("opt-out", false)) {
- return;
+ /**
+ * Adds a custom data plotter to the default graph
+ *
+ * @param plotter
+ */
+ public void addCustomData(final Plotter plotter) {
+ if (plotter == null) {
+ throw new IllegalArgumentException("Plotter cannot be null");
}
- // First tell the server about us
- postPlugin(plugin, false);
+ // Add the plotter to the graph o/
+ defaultGraph.addPlotter(plotter);
+
+ // Ensure the default graph is included in the submitted graphs
+ graphs.add(defaultGraph);
+ }
- // Ping the server in intervals
- plugin.getServer().getScheduler().scheduleAsyncRepeatingTask(plugin, new Runnable() {
- @Override
- public void run() {
- try {
- postPlugin(plugin, true);
- } catch (IOException e) {
- System.out.println("[Metrics] " + e.getMessage());
+ /**
+ * Start measuring statistics. This will immediately create an async repeating task as the plugin and send
+ * the initial data to the metrics backend, and then after that it will post in increments of
+ * PING_INTERVAL * 1200 ticks.
+ *
+ * @return True if statistics measuring is running, otherwise false.
+ */
+ public boolean start() {
+ synchronized (optOutLock) {
+ // Did we opt out?
+ if (isOptOut()) {
+ return false;
+ }
+
+ // Is metrics already running?
+ if (taskId >= 0) {
+ return true;
+ }
+
+ // Begin hitting the server with glorious data
+ taskId = plugin.getServer().getScheduler().scheduleAsyncRepeatingTask(plugin, new Runnable() {
+
+ private boolean firstPost = true;
+
+ public void run() {
+ try {
+ // This has to be synchronized or it can collide with the disable method.
+ synchronized (optOutLock) {
+ // Disable Task, if it is running and the server owner decided to opt-out
+ if (isOptOut() && taskId > 0) {
+ plugin.getServer().getScheduler().cancelTask(taskId);
+ taskId = -1;
+ }
+ }
+
+ // We use the inverse of firstPost because if it is the first time we are posting,
+ // it is not a interval ping, so it evaluates to FALSE
+ // Each time thereafter it will evaluate to TRUE, i.e PING!
+ postPlugin(!firstPost);
+
+ // After the first post we set firstPost to false
+ // Each post thereafter will be a ping
+ firstPost = false;
+ } catch (IOException e) {
+ Bukkit.getLogger().log(Level.INFO, "[Metrics] " + e.getMessage());
+ }
}
+ }, 0, PING_INTERVAL * 1200);
+
+ return true;
+ }
+ }
+
+ /**
+ * Has the server owner denied plugin metrics?
+ *
+ * @return
+ */
+ public boolean isOptOut() {
+ synchronized(optOutLock) {
+ try {
+ // Reload the metrics file
+ configuration.load(CONFIG_FILE);
+ } catch (IOException ex) {
+ Bukkit.getLogger().log(Level.INFO, "[Metrics] " + ex.getMessage());
+ return true;
+ } catch (InvalidConfigurationException ex) {
+ Bukkit.getLogger().log(Level.INFO, "[Metrics] " + ex.getMessage());
+ return true;
}
- }, PING_INTERVAL * 1200, PING_INTERVAL * 1200);
+ return configuration.getBoolean("opt-out", false);
+ }
}
- private boolean isMineshafterPresent() {
- try {
- Class.forName("mineshafter.MineServer");
- return true;
- } catch (Exception e) {
- return false;
+ /**
+ * Enables metrics for the server by setting "opt-out" to false in the config file and starting the metrics task.
+ *
+ * @throws IOException
+ */
+ public void enable() throws IOException {
+ // This has to be synchronized or it can collide with the check in the task.
+ synchronized (optOutLock) {
+ // Check if the server owner has already set opt-out, if not, set it.
+ if (isOptOut()) {
+ configuration.set("opt-out", false);
+ configuration.save(configurationFile);
+ }
+
+ // Enable Task, if it is not running
+ if (taskId < 0) {
+ start();
+ }
}
}
- private void postPlugin(Plugin plugin, boolean isPing) throws IOException {
+ /**
+ * Disables metrics for the server by setting "opt-out" to true in the config file and canceling the metrics task.
+ *
+ * @throws IOException
+ */
+ public void disable() throws IOException {
+ // This has to be synchronized or it can collide with the check in the task.
+ synchronized (optOutLock) {
+ // Check if the server owner has already set opt-out, if not, set it.
+ if (!isOptOut()) {
+ configuration.set("opt-out", true);
+ configuration.save(configurationFile);
+ }
+
+ // Disable Task, if it is running
+ if (taskId > 0) {
+ this.plugin.getServer().getScheduler().cancelTask(taskId);
+ taskId = -1;
+ }
+ }
+ }
+
+ /**
+ * Generic method that posts a plugin to the metrics website
+ */
+ private void postPlugin(final boolean isPing) throws IOException {
+ // The plugin's description file containg all of the plugin data such as name, version, author, etc
+ final PluginDescriptionFile description = plugin.getDescription();
+
// Construct the post data
- String response = "ERR No response";
- String data = encode("guid") + '=' + encode(guid) + '&' + encode("version") + '='
- + encode(plugin.getDescription().getVersion()) + '&' + encode("server") + '='
- + encode(Bukkit.getVersion()) + '&' + encode("players") + '='
- + encode(String.valueOf(Bukkit.getServer().getOnlinePlayers().length)) + '&' + encode("revision") + '='
- + encode(REVISION + "");
+ final StringBuilder data = new StringBuilder();
+ data.append(encode("guid")).append('=').append(encode(guid));
+ encodeDataPair(data, "version", description.getVersion());
+ encodeDataPair(data, "server", Bukkit.getVersion());
+ encodeDataPair(data, "players", Integer.toString(Bukkit.getServer().getOnlinePlayers().length));
+ encodeDataPair(data, "revision", String.valueOf(REVISION));
// If we're pinging, append it
if (isPing) {
- data += '&' + encode("ping") + '=' + encode("true");
+ encodeDataPair(data, "ping", "true");
}
- // Add any custom data (if applicable)
- Set<Plotter> plotters = customData.get(plugin);
-
- if (plotters != null) {
- for (Plotter plotter : plotters) {
- data += "&" + encode("Custom" + plotter.getColumnName()) + "="
- + encode(Integer.toString(plotter.getValue()));
+ // Acquire a lock on the graphs, which lets us make the assumption we also lock everything
+ // inside of the graph (e.g plotters)
+ synchronized (graphs) {
+ final Iterator<Graph> iter = graphs.iterator();
+
+ while (iter.hasNext()) {
+ final Graph graph = iter.next();
+
+ // Because we have a lock on the graphs set already, it is reasonable to assume
+ // that our lock transcends down to the individual plotters in the graphs also.
+ // Because our methods are private, no one but us can reasonably access this list
+ // without reflection so this is a safe assumption without adding more code.
+ for (Plotter plotter : graph.getPlotters()) {
+ // The key name to send to the metrics server
+ // The format is C-GRAPHNAME-PLOTTERNAME where separator - is defined at the top
+ // Legacy (R4) submitters use the format Custom%s, or CustomPLOTTERNAME
+ final String key = String.format("C%s%s%s%s", CUSTOM_DATA_SEPARATOR, graph.getName(), CUSTOM_DATA_SEPARATOR, plotter.getColumnName());
+
+ // The value to send, which for the foreseeable future is just the string
+ // value of plotter.getValue()
+ final String value = Integer.toString(plotter.getValue());
+
+ // Add it to the http post data :)
+ encodeDataPair(data, key, value);
+ }
}
}
// Create the url
- URL url = new URL(BASE_URL + String.format(REPORT_URL, plugin.getDescription().getName()));
+ URL url = new URL(BASE_URL + String.format(REPORT_URL, encode(plugin.getDescription().getName())));
// Connect to the website
URLConnection connection;
// Mineshafter creates a socks proxy, so we can safely bypass it
+ // It does not reroute POST requests so we need to go around it
if (isMineshafterPresent()) {
connection = url.openConnection(Proxy.NO_PROXY);
} else {
@@ -155,70 +383,217 @@ private void postPlugin(Plugin plugin, boolean isPing) throws IOException {
connection.setDoOutput(true);
// Write the data
- OutputStreamWriter writer = new OutputStreamWriter(connection.getOutputStream());
- writer.write(data);
+ final OutputStreamWriter writer = new OutputStreamWriter(connection.getOutputStream());
+ writer.write(data.toString());
writer.flush();
// Now read the response
- BufferedReader reader = new BufferedReader(new InputStreamReader(connection.getInputStream()));
- response = reader.readLine();
+ final BufferedReader reader = new BufferedReader(new InputStreamReader(connection.getInputStream()));
+ final String response = reader.readLine();
// close resources
writer.close();
reader.close();
- if (response.startsWith("ERR")) {
- throw new IOException(response); // Throw the exception
+ if (response == null || response.startsWith("ERR")) {
+ throw new IOException(response); //Throw the exception
} else {
// Is this the first update this hour?
if (response.contains("OK This is your first update this hour")) {
- if (plotters != null) {
- for (Plotter plotter : plotters) {
- plotter.reset();
+ synchronized (graphs) {
+ final Iterator<Graph> iter = graphs.iterator();
+
+ while (iter.hasNext()) {
+ final Graph graph = iter.next();
+
+ for (Plotter plotter : graph.getPlotters()) {
+ plotter.reset();
+ }
}
}
}
}
- // if (response.startsWith("OK")) - We should get "OK" followed by an
- // optional description if everything goes right
+ //if (response.startsWith("OK")) - We should get "OK" followed by an optional description if everything goes right
}
- public static abstract class Plotter {
+ /**
+ * Check if mineshafter is present. If it is, we need to bypass it to send POST requests
+ *
+ * @return
+ */
+ private boolean isMineshafterPresent() {
+ try {
+ Class.forName("mineshafter.MineServer");
+ return true;
+ } catch (Exception e) {
+ return false;
+ }
+ }
- @Override
- public boolean equals(Object object) {
- if (!(object instanceof Plotter)) {
- return false;
- }
+ /**
+ * <p>Encode a key/value data pair to be used in a HTTP post request. This INCLUDES a & so the first
+ * key/value pair MUST be included manually, e.g:</p>
+ * <code>
+ * StringBuffer data = new StringBuffer();
+ * data.append(encode("guid")).append('=').append(encode(guid));
+ * encodeDataPair(data, "version", description.getVersion());
+ * </code>
+ *
+ * @param buffer
+ * @param key
+ * @param value
+ * @return
+ */
+ private static void encodeDataPair(final StringBuilder buffer, final String key, final String value) throws UnsupportedEncodingException {
+ buffer.append('&').append(encode(key)).append('=').append(encode(value));
+ }
+
+ /**
+ * Encode text as UTF-8
+ *
+ * @param text
+ * @return
+ */
+ private static String encode(final String text) throws UnsupportedEncodingException {
+ return URLEncoder.encode(text, "UTF-8");
+ }
- Plotter plotter = (Plotter) object;
- return plotter.getColumnName().equals(getColumnName()) && plotter.getValue() == getValue();
+ /**
+ * Represents a custom graph on the website
+ */
+ public static class Graph {
+
+ /**
+ * The graph's name, alphanumeric and spaces only :)
+ * If it does not comply to the above when submitted, it is rejected
+ */
+ private final String name;
+
+ /**
+ * The set of plotters that are contained within this graph
+ */
+ private final Set<Plotter> plotters = new LinkedHashSet<Plotter>();
+
+ private Graph(final String name) {
+ this.name = name;
}
- public abstract String getColumnName();
+ /**
+ * Gets the graph's name
+ *
+ * @return
+ */
+ public String getName() {
+ return name;
+ }
- public abstract int getValue();
+ /**
+ * Add a plotter to the graph, which will be used to plot entries
+ *
+ * @param plotter
+ */
+ public void addPlotter(final Plotter plotter) {
+ plotters.add(plotter);
+ }
+
+ /**
+ * Remove a plotter from the graph
+ *
+ * @param plotter
+ */
+ public void removePlotter(final Plotter plotter) {
+ plotters.remove(plotter);
+ }
+
+ /**
+ * Gets an <b>unmodifiable</b> set of the plotter objects in the graph
+ *
+ * @return
+ */
+ public Set<Plotter> getPlotters() {
+ return Collections.unmodifiableSet(plotters);
+ }
@Override
public int hashCode() {
- return getColumnName().hashCode() + getValue();
+ return name.hashCode();
}
- public void reset() {
+ @Override
+ public boolean equals(final Object object) {
+ if (!(object instanceof Graph)) {
+ return false;
+ }
+
+ final Graph graph = (Graph) object;
+ return graph.name.equals(name);
}
+
}
- private static final String BASE_URL = "http://metrics.griefcraft.com";
+ /**
+ * Interface used to collect custom data for a plugin
+ */
+ public static abstract class Plotter {
- private static final String CONFIG_FILE = "plugins/PluginMetrics/config.yml";
+ /**
+ * The plot's name
+ */
+ private final String name;
- private final static int PING_INTERVAL = 10;
+ /**
+ * Construct a plotter with the default plot name
+ */
+ public Plotter() {
+ this("Default");
+ }
- private static final String REPORT_URL = "/report/%s";
+ /**
+ * Construct a plotter with a specific plot name
+ *
+ * @param name
+ */
+ public Plotter(final String name) {
+ this.name = name;
+ }
- private final static int REVISION = 4;
+ /**
+ * Get the current value for the plotted point
+ *
+ * @return
+ */
+ public abstract int getValue();
+
+ /**
+ * Get the column name for the plotted point
+ *
+ * @return the plotted point's column name
+ */
+ public String getColumnName() {
+ return name;
+ }
+
+ /**
+ * Called after the website graphs have been updated
+ */
+ public void reset() {
+ }
+
+ @Override
+ public int hashCode() {
+ return getColumnName().hashCode() + getValue();
+ }
+
+ @Override
+ public boolean equals(final Object object) {
+ if (!(object instanceof Plotter)) {
+ return false;
+ }
+
+ final Plotter plotter = (Plotter) object;
+ return plotter.name.equals(name) && plotter.getValue() == getValue();
+ }
- private static String encode(String text) throws UnsupportedEncodingException {
- return URLEncoder.encode(text, "UTF-8");
}
+
}
Something went wrong with that request. Please try again.