taco.tacoapi.api

Class Metrics

java.lang.Object

taco.tacoapi.api.Metrics

public class Metrics
extends java.lang.Object

The metrics class obtains data about a plugin and submits statistics about it to the metrics backend.

Public methods provided by this class:

Graph createGraph(String name);
void addCustomData(Metrics.Plotter plotter);
void start();


Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Metrics.Graph Represents a custom graph on the website
static class	Metrics.Plotter Interface used to collect custom data for a plugin

Field Summary

Fields

Modifier and Type	Field and Description
private static java.lang.String	BASE_URL The base url of the metrics domain
private org.bukkit.configuration.file.YamlConfiguration	configuration The plugin configuration file
private java.io.File	configurationFile The plugin configuration file
private static java.lang.String	CUSTOM_DATA_SEPARATOR The separator to use for custom data.
private Metrics.Graph	defaultGraph The default graph, used for addCustomData when you don't want a specific graph
private java.util.Set<Metrics.Graph>	graphs All of the custom graphs to submit to metrics
private java.lang.String	guid Unique server id
private java.lang.Object	optOutLock Lock for synchronization
private static int	PING_INTERVAL Interval of time to ping (in minutes)
private org.bukkit.plugin.Plugin	plugin The plugin this metrics submits for
private static java.lang.String	REPORT_URL The url used to report a server's status
private static int	REVISION The current revision number
private int	taskId Id of the scheduled task

Constructor Summary

Constructors

Constructor and Description
Metrics(org.bukkit.plugin.Plugin plugin)

Method Summary

Methods

Modifier and Type	Method and Description
void	addCustomData(Metrics.Plotter plotter) Adds a custom data plotter to the default graph
void	addGraph(Metrics.Graph graph) Add a Graph object to Metrics that represents data for the plugin that should be sent to the backend
Metrics.Graph	createGraph(java.lang.String name) Construct and create a Graph that can be used to separate specific plotters to their own graphs on the metrics website.
void	disable() Disables metrics for the server by setting "opt-out" to true in the config file and canceling the metrics task.
void	enable() Enables metrics for the server by setting "opt-out" to false in the config file and starting the metrics task.
private static java.lang.String	encode(java.lang.String text) Encode text as UTF-8
private static void	encodeDataPair(java.lang.StringBuilder buffer, java.lang.String key, java.lang.String value) Encode a key/value data pair to be used in a HTTP post request.
java.io.File	getConfigFile() Gets the File object of the config file that should be used to store data such as the GUID and opt-out status
private boolean	isMineshafterPresent() Check if mineshafter is present.
boolean	isOptOut() Has the server owner denied plugin metrics?
private void	postPlugin(boolean isPing) Generic method that posts a plugin to the metrics website
boolean	start() Start measuring statistics.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

REVISION

private static final int REVISION

The current revision number

See Also:

Constant Field Values

BASE_URL

private static final java.lang.String BASE_URL

The base url of the metrics domain

See Also:

Constant Field Values

REPORT_URL

private static final java.lang.String REPORT_URL

The url used to report a server's status

See Also:

Constant Field Values

CUSTOM_DATA_SEPARATOR

private static final java.lang.String CUSTOM_DATA_SEPARATOR

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.

See Also:

Constant Field Values

PING_INTERVAL

private static final int PING_INTERVAL

Interval of time to ping (in minutes)

See Also:

Constant Field Values

plugin

private final org.bukkit.plugin.Plugin plugin

The plugin this metrics submits for

graphs

private final java.util.Set<Metrics.Graph> graphs

All of the custom graphs to submit to metrics

defaultGraph

private final Metrics.Graph defaultGraph

The default graph, used for addCustomData when you don't want a specific graph

configuration

private final org.bukkit.configuration.file.YamlConfiguration configuration

The plugin configuration file

configurationFile

private final java.io.File configurationFile

The plugin configuration file

guid

private final java.lang.String guid

Unique server id

optOutLock

private final java.lang.Object optOutLock

Lock for synchronization

taskId

private volatile int taskId

Id of the scheduled task

Constructor Detail

Metrics

public Metrics(org.bukkit.plugin.Plugin plugin)
        throws java.io.IOException

Throws:

java.io.IOException

Method Detail

createGraph

public Metrics.Graph createGraph(java.lang.String name)

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.

Parameters:

name - The name of the graph

Returns:

Graph object created. Will never return NULL under normal circumstances unless bad parameters are given

addGraph

public void addGraph(Metrics.Graph graph)

Add a Graph object to Metrics that represents data for the plugin that should be sent to the backend

Parameters:

graph - The name of the graph

addCustomData

public void addCustomData(Metrics.Plotter plotter)

Adds a custom data plotter to the default graph

Parameters:

plotter - The plotter to use to plot custom data

start

public boolean start()

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.

Returns:

True if statistics measuring is running, otherwise false.

isOptOut

public boolean isOptOut()

Has the server owner denied plugin metrics?

Returns:

true if metrics should be opted out of it

enable

public void enable()
            throws java.io.IOException

Enables metrics for the server by setting "opt-out" to false in the config file and starting the metrics task.

Throws:

java.io.IOException

disable

public void disable()
             throws java.io.IOException

Disables metrics for the server by setting "opt-out" to true in the config file and canceling the metrics task.

Throws:

java.io.IOException

getConfigFile

public java.io.File getConfigFile()

Gets the File object of the config file that should be used to store data such as the GUID and opt-out status

Returns:

the File object for the config file

postPlugin

private void postPlugin(boolean isPing)
                 throws java.io.IOException

Generic method that posts a plugin to the metrics website

Throws:

java.io.IOException

isMineshafterPresent

private boolean isMineshafterPresent()

Check if mineshafter is present. If it is, we need to bypass it to send POST requests

Returns:

true if mineshafter is installed on the server

encodeDataPair

private static void encodeDataPair(java.lang.StringBuilder buffer,
                  java.lang.String key,
                  java.lang.String value)
                            throws java.io.UnsupportedEncodingException

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:

StringBuffer data = new StringBuffer(); data.append(encode("guid")).append('=').append(encode(guid)); encodeDataPair(data, "version", description.getVersion());

Parameters:

buffer - the stringbuilder to append the data pair onto

key - the key value

value - the value

Throws:

java.io.UnsupportedEncodingException

encode

private static java.lang.String encode(java.lang.String text)
                                throws java.io.UnsupportedEncodingException

Encode text as UTF-8

Parameters:

text - the text to encode

Returns:

the encoded text, as UTF-8

Throws:

java.io.UnsupportedEncodingException