org.jmxtrans.embedded.output

Class StackdriverWriter

java.lang.Object

org.jmxtrans.embedded.output.AbstractOutputWriter

org.jmxtrans.embedded.output.StackdriverWriter

All Implemented Interfaces:

OutputWriter

public class StackdriverWriter
extends AbstractOutputWriter
implements OutputWriter

Stackdriver implementation of the OutputWriter.

This implementation uses POST /v1/metrics HTTP API.

Settings:

• "url": Stackdriver server URL. Optional, default value: "https://custom-gateway.stackdriver.com/v1/custom".
• "token": Stackdriver API token. Mandatory
• "source": Instance of the machine ID that the JMX data is being collected from. Optional.
• "detectInstance": Set to "AWS" if you want to detect the local AWS instance ID on startup. Optional.
• "stackdriverApiTimeoutInMillis": read timeout of the calls to Stackdriver HTTP API. Optional, default value: 1000.
• "enabled": flag to enable/disable the writer. Optional, default value: true.

Author:

Eric Kilby

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_STACKDRIVER_API_TIMEOUT_IN_MILLIS
static String	DEFAULT_STACKDRIVER_API_URL
static String	SETTING_DETECT_INSTANCE
static String	SETTING_SOURCE_INSTANCE
static String	SETTING_STACKDRIVER_API_TIMEOUT_IN_MILLIS
static int	STACKDRIVER_PROTOCOL_VERSION

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
StackdriverWriter()

Method Summary

Methods

Modifier and Type	Method and Description
int	getExceptionCounter()
void	serialize(Iterable<QueryResult> results, OutputStream out) Put the values into the JSON format expected by the Stackdriver custom metrics gateway
void	start() Initial setup for the writer class.
void	write(Iterable<QueryResult> results) Send given metrics to the Stackdriver server using HTTP

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

STACKDRIVER_PROTOCOL_VERSION

public static final int STACKDRIVER_PROTOCOL_VERSION

See Also:

Constant Field Values

SETTING_SOURCE_INSTANCE

public static final String SETTING_SOURCE_INSTANCE

See Also:

Constant Field Values

SETTING_DETECT_INSTANCE

public static final String SETTING_DETECT_INSTANCE

See Also:

Constant Field Values

DEFAULT_STACKDRIVER_API_URL

public static final String DEFAULT_STACKDRIVER_API_URL

See Also:

Constant Field Values

SETTING_STACKDRIVER_API_TIMEOUT_IN_MILLIS

public static final String SETTING_STACKDRIVER_API_TIMEOUT_IN_MILLIS

See Also:

Constant Field Values

DEFAULT_STACKDRIVER_API_TIMEOUT_IN_MILLIS

public static final int DEFAULT_STACKDRIVER_API_TIMEOUT_IN_MILLIS

See Also:

Constant Field Values

Constructor Detail

StackdriverWriter

public StackdriverWriter()

Method Detail

start

public void start()

Initial setup for the writer class. Loads in settings and initializes one-time setup variables like instanceId.

Specified by:

start in interface OutputWriter

Overrides:

start in class AbstractOutputWriter

write

public void write(Iterable<QueryResult> results)

Send given metrics to the Stackdriver server using HTTP

Specified by:

write in interface OutputWriter

Specified by:

write in class AbstractOutputWriter

Parameters:

results - Iterable collection of data points

serialize

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

Put the values into the JSON format expected by the Stackdriver custom metrics gateway

Parameters:

results - Iterable collection of data points (gauges and counters)

out - OutputStream to write JSON to

Throws:

IOException

getExceptionCounter

public int getExceptionCounter()