org.jmxtrans.embedded.output

Class LibratoWriter

java.lang.Object

org.jmxtrans.embedded.output.AbstractOutputWriter

org.jmxtrans.embedded.output.LibratoWriter

All Implemented Interfaces:

OutputWriter

public class LibratoWriter
extends AbstractOutputWriter
implements OutputWriter

Librato Metrics implementation of the OutputWriter.

This implementation uses POST /v1/metrics HTTP API.

LibratoWriter uses the "query.attribute.type" configuration parameter (via QueryResult.getType()) to publish the metrics.
Supported types are "counter" and "gauge".
If the type is null or unsupported, metric is exported as "counter".

Settings:

• "url": Librato server URL. Optional, default value: "https://metrics-api.librato.com/v1/metrics".
• "user": Librato user. Mandatory
• "token": Librato token. Mandatory
• "libratoApiTimeoutInMillis": read timeout of the calls to Librato HTTP API. Optional, default value: 1000.
• "enabled": flag to enable/disable the writer. Optional, default value: true.
• "source": Librato . Optional, default value: "#hostname#" (the hostname of the server).

Author:

Cyrille Le Clerc

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_LIBRATO_API_TIMEOUT_IN_MILLIS
static String	DEFAULT_LIBRATO_API_URL
static String	DEFAULT_SOURCE
protected String	httpUserAgent See How to set a custom User Agent when integrating with Librato
static String	METRIC_TYPE_COUNTER
static String	METRIC_TYPE_GAUGE
static String	SETTING_LIBRATO_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
LibratoWriter()

Method Summary

Methods

Modifier and Type	Method and Description
int	getExceptionCounter()
void	serialize(Iterable<QueryResult> counters, Iterable<QueryResult> gauges, OutputStream out)
void	start() Load settings
void	write(Iterable<QueryResult> results) Send given metrics to the Graphite server.

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_LIBRATO_API_URL

public static final String DEFAULT_LIBRATO_API_URL

See Also:

Constant Field Values

SETTING_LIBRATO_API_TIMEOUT_IN_MILLIS

public static final String SETTING_LIBRATO_API_TIMEOUT_IN_MILLIS

See Also:

Constant Field Values

DEFAULT_LIBRATO_API_TIMEOUT_IN_MILLIS

public static final int DEFAULT_LIBRATO_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

httpUserAgent

See How to set a custom User Agent when integrating with Librato

TODO discover embedded-jmxtrans' version from maven's embedded pom.xml instead of hardcoding "1"

Constructor Detail

LibratoWriter

public LibratoWriter()

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)

Send given metrics to the Graphite server.

Specified by:

write in interface OutputWriter

Specified by:

write in class AbstractOutputWriter

serialize

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

Throws:

IOException

getExceptionCounter

public int getExceptionCounter()