org.jmxtrans.embedded.output

Class CopperEggWriter

java.lang.Object

org.jmxtrans.embedded.output.AbstractOutputWriter

org.jmxtrans.embedded.output.CopperEggWriter

All Implemented Interfaces:

OutputWriter

public class CopperEggWriter
extends AbstractOutputWriter
implements OutputWriter

CopperEgg Metrics implementation of the OutputWriter.

This implementation uses v2 of the CopperEgg API

Settings:

• "url": CopperEgg API server URL. Optional, default value: "https://api.copperegg.com/v2/revealmetrics".
• "user": CopperEgg user. Mandatory
• "token": CopperEgg APIKEY. Mandatory
• "coppereggApiTimeoutInMillis": read timeout of the calls to CopperEgg HTTP API. Optional, default value: 20000.
• "enabled": flag to enable/disable the writer. Optional, default value: true.
• "source": CopperEgg . Optional, default value: "#hostname#" (the hostname of the server).

LibratoWriter.java author:

Author:

Cyrille Le Clerc CopperEggWriter.java was derived from LibratoWriter.java, Scott Johnson

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_COPPEREGG_API_TIMEOUT_IN_MILLIS
static String	DEFAULT_COPPEREGG_API_URL
static String	DEFAULT_SOURCE
static String	METRIC_TYPE_COUNTER
static String	METRIC_TYPE_GAUGE
static String	SETTING_COPPEREGG_API_TIMEOUT_IN_MILLIS
static String	SETTING_SOURCE

Fields inherited from class org.jmxtrans.embedded.output.AbstractOutputWriter

SETTING_HOST, SETTING_NAME_PREFIX, SETTING_PORT, SETTING_PROXY_HOST, SETTING_PROXY_PORT, SETTING_TOKEN, SETTING_URL, SETTING_USERNAME

Constructor Summary

Constructors

Constructor and Description
CopperEggWriter()

Method Summary

Methods

Modifier and Type	Method and Description
String	convertStreamToString(InputStream is)
int	cue_getExceptionCounter()
void	cue_serialize(Iterable<QueryResult> counters, OutputStream out)
void	ensure_metric_groups() If metric group doesn't exist, create it If it does exist, update it.
String	groupFind(String findName, String findIndex, Integer ExpectInt)
void	one_set(String mg_name, List<QueryResult> counters)
void	read_config(InputStream in) read_config() The copperegg_config.json file contains a specification for the metric groups and dashboards to be created / or updated.
String	Send_Commmand(String command, String msgtype, String payload, Integer ExpectInt)
void	send_metrics(String mg_name, List<QueryResult> counters)
void	sort_n_send(String mg_name, List<QueryResult> mg_counters)
void	start() Load settings
String	write_tostring(com.fasterxml.jackson.databind.JsonNode json)
void	write(Iterable<QueryResult> results) Export collected metrics to CopperEgg

Methods inherited from class org.jmxtrans.embedded.output.AbstractOutputWriter

equals, getBooleanSetting, getIntSetting, getIntSetting, getLongSetting, getSettings, getStrategy, getStringSetting, getStringSetting, hashCode, isEnabled, setEnabled, setSettings, setStrategy, stop, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.jmxtrans.embedded.output.OutputWriter

getSettings, isEnabled, setEnabled, setSettings, stop

Field Detail

METRIC_TYPE_GAUGE

public static final String METRIC_TYPE_GAUGE

See Also:

Constant Field Values

METRIC_TYPE_COUNTER

public static final String METRIC_TYPE_COUNTER

See Also:

Constant Field Values

DEFAULT_COPPEREGG_API_URL

public static final String DEFAULT_COPPEREGG_API_URL

See Also:

Constant Field Values

SETTING_COPPEREGG_API_TIMEOUT_IN_MILLIS

public static final String SETTING_COPPEREGG_API_TIMEOUT_IN_MILLIS

See Also:

Constant Field Values

DEFAULT_COPPEREGG_API_TIMEOUT_IN_MILLIS

public static final int DEFAULT_COPPEREGG_API_TIMEOUT_IN_MILLIS

See Also:

Constant Field Values

SETTING_SOURCE

public static final String SETTING_SOURCE

See Also:

Constant Field Values

DEFAULT_SOURCE

public static final String DEFAULT_SOURCE

See Also:

Constant Field Values

Constructor Detail

CopperEggWriter

public CopperEggWriter()

Method Detail

start

public void start()

Load settings

Specified by:

start in interface OutputWriter

Overrides:

start in class AbstractOutputWriter

write

public void write(Iterable<QueryResult> results)

Export collected metrics to CopperEgg

Specified by:

write in interface OutputWriter

Specified by:

write in class AbstractOutputWriter

sort_n_send

public void sort_n_send(String mg_name,
               List<QueryResult> mg_counters)

send_metrics

public void send_metrics(String mg_name,
                List<QueryResult> counters)

one_set

public void one_set(String mg_name,
           List<QueryResult> counters)

cue_serialize

public void cue_serialize(@Nonnull
                 Iterable<QueryResult> counters,
                 @Nonnull
                 OutputStream out)
                   throws IOException

Throws:

IOException

cue_getExceptionCounter

public int cue_getExceptionCounter()

ensure_metric_groups

public void ensure_metric_groups()

If metric group doesn't exist, create it If it does exist, update it.

convertStreamToString

public String convertStreamToString(InputStream is)
                             throws IOException

Throws:

IOException

read_config

public void read_config(InputStream in)
                 throws Exception

read_config() The copperegg_config.json file contains a specification for the metric groups and dashboards to be created / or updated. Mandatory

Throws:

Exception

groupFind

public String groupFind(String findName,
               String findIndex,
               Integer ExpectInt)
                 throws Exception

Throws:

Exception

write_tostring

public String write_tostring(com.fasterxml.jackson.databind.JsonNode json)

Send_Commmand

public String Send_Commmand(String command,
                   String msgtype,
                   String payload,
                   Integer ExpectInt)