com.googlecode.jmxtrans.model.output

Class StackdriverWriter

java.lang.Object

com.googlecode.jmxtrans.model.output.BaseOutputWriter

com.googlecode.jmxtrans.model.output.StackdriverWriter

All Implemented Interfaces:

OutputWriter, OutputWriterFactory, AutoCloseable

public class StackdriverWriter
extends BaseOutputWriter

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
• "prefix": Prefix for the metric names. If present will be prepended to the metric name. Should be alphanumeric. Optional, shouldn't be used at the same time as source or detectInstance. Different way of namespacing.
• "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.
• "timeoutInMillis": 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_PREFIX
static String	SETTING_PROXY_HOST
static String	SETTING_PROXY_PORT
static String	SETTING_SOURCE_INSTANCE
static String	SETTING_STACKDRIVER_API_KEY
static String	SETTING_STACKDRIVER_API_TIMEOUT_IN_MILLIS
static String	SETTING_STACKDRIVER_API_URL
static int	STACKDRIVER_PROTOCOL_VERSION

Fields inherited from class com.googlecode.jmxtrans.model.output.BaseOutputWriter

BINARY_PATH, BOOLEAN_AS_NUMBER, DEBUG, HOST, OUTPUT_FILE, PORT, TEMPLATE_FILE, TYPE_NAMES

Constructor Summary

Constructors

Constructor and Description
StackdriverWriter(com.google.common.collect.ImmutableList<String> typeNames, boolean booleanAsNumber, Boolean debugEnabled, String gatewayUrl, String apiKey, String proxyHost, Integer proxyPort, String prefix, Integer timeoutInMillis, String source, String detectInstance, Map<String,Object> settings)

Method Summary

Modifier and Type	Method and Description
String	getApiKey()
String	getDetectInstance()
String	getGatewayUrl()
String	getPrefix()
String	getProxyHost()
Integer	getProxyPort()
String	getSource()
int	getTimeoutInMillis()
void	internalWrite(Server server, Query query, com.google.common.collect.ImmutableList<Result> results) Implementation of the base writing method.
void	validateSetup(Server server, Query query) Sets up the object and makes sure all the required parameters are available Minimally a Stackdriver API key must be provided using the token setting

Methods inherited from class com.googlecode.jmxtrans.model.output.BaseOutputWriter

close, create, doWrite, firstNonNull, getConcatedTypeNameValues, getSettings, getTypeNames, isDebugEnabled, start, toString

Methods inherited from class java.lang.Object

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

Field Detail

STACKDRIVER_PROTOCOL_VERSION

public static final int STACKDRIVER_PROTOCOL_VERSION

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

DEFAULT_STACKDRIVER_API_URL

public static final String DEFAULT_STACKDRIVER_API_URL

See Also:

Constant Field Values

SETTING_STACKDRIVER_API_URL

public static final String SETTING_STACKDRIVER_API_URL

See Also:

Constant Field Values

SETTING_PROXY_PORT

public static final String SETTING_PROXY_PORT

See Also:

Constant Field Values

SETTING_PROXY_HOST

public static final String SETTING_PROXY_HOST

See Also:

Constant Field Values

SETTING_STACKDRIVER_API_KEY

public static final String SETTING_STACKDRIVER_API_KEY

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

SETTING_STACKDRIVER_API_TIMEOUT_IN_MILLIS

public static final String SETTING_STACKDRIVER_API_TIMEOUT_IN_MILLIS

See Also:

Constant Field Values

SETTING_PREFIX

public static final String SETTING_PREFIX

See Also:

Constant Field Values

Constructor Detail

StackdriverWriter

public StackdriverWriter(com.google.common.collect.ImmutableList<String> typeNames,
                         boolean booleanAsNumber,
                         Boolean debugEnabled,
                         String gatewayUrl,
                         String apiKey,
                         String proxyHost,
                         Integer proxyPort,
                         String prefix,
                         Integer timeoutInMillis,
                         String source,
                         String detectInstance,
                         Map<String,Object> settings)
                  throws MalformedURLException

Throws:

MalformedURLException

Method Detail

validateSetup

public void validateSetup(Server server,
                          Query query)
                   throws ValidationException

Sets up the object and makes sure all the required parameters are available
Minimally a Stackdriver API key must be provided using the token setting

Throws:

ValidationException

internalWrite

public void internalWrite(Server server,
                          Query query,
                          com.google.common.collect.ImmutableList<Result> results)
                   throws Exception

Implementation of the base writing method. Operates in two stages:
First turns the query result into a JSON message in Stackdriver format
Second posts the message to the Stackdriver gateway via HTTP

Specified by:

internalWrite in class BaseOutputWriter

Throws:

Exception

getGatewayUrl

public String getGatewayUrl()

getProxyHost

public String getProxyHost()

getProxyPort

public Integer getProxyPort()

getPrefix

public String getPrefix()

getApiKey

public String getApiKey()

getTimeoutInMillis

public int getTimeoutInMillis()

getSource

public String getSource()

getDetectInstance

public String getDetectInstance()