org.jmxtrans.embedded.output

Class GraphiteWriter

java.lang.Object

org.jmxtrans.embedded.output.AbstractOutputWriter

org.jmxtrans.embedded.output.GraphiteWriter

All Implemented Interfaces:

OutputWriter

public class GraphiteWriter
extends AbstractOutputWriter
implements OutputWriter

Graphite implementation of the OutputWriter. This implementation uses Carbon Plan Text protocol over TCP/IP. Settings:

• "host": hostname or ip address of the Graphite server. Mandatory
• "port": listen port for the TCP Plain Text Protocol of the Graphite server. Optional, default value: 2003.
• "namePrefix": prefix append to the metrics name. Optional, default value: "servers.#hostname#.".
• "enabled": flag to enable/disable the writer. Optional, default value: {$code true}.
• "graphite.socketConnectTimeoutInMillis": timeout for the socketConnect in millis. Optional, default value: SocketWriterPoolFactory.DEFAULT_SOCKET_CONNECT_TIMEOUT_IN_MILLIS
• "socketFactory": name of a custom javax.net.SocketFactory to customize the SocketFactory used to connect to the Graphite server
• "protocol": "TCP" or "UDP". Optional, the default value is "TCP"
• "useTls": for "TCP", boolean to use TLS/SSL. Optional, default is "false"
• "tls.insecure": please don't. For TLS/SSL, disable x509 certificate checks. Optional, default is "false"
• "tls.keyStore": path to the given JKS key store. Can be a classpath resource ("classpath:com/example/keystore.jks") of file system related. Optional, if {code null}, then the JVM key store is used.
• "tls.keyStorePassword": password to open the key store.
• "tls.trustStore": path to the given JKS trust store. Can be a classpath resource ("classpath:com/example/truststore.jks") of file system related. Optional, if {code null}, then the JVM key store is used.
• "tls.trustStorePassword": password to open the trust store.

Author:

Cyrille Le Clerc, Patrick Brühlmann

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_GRAPHITE_SERVER_PORT
static String	DEFAULT_NAME_PREFIX

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

SETTING_HOST, SETTING_NAME_PREFIX, SETTING_PORT, SETTING_PROTOCOL, SETTING_PROXY_HOST, SETTING_PROXY_PORT, SETTING_SOCKET_FACTORY, SETTING_TLS_INSECURE, SETTING_TLS_KEY_STORE, SETTING_TLS_KEY_STORE_PASSWORD, SETTING_TLS_TRUST_STORE, SETTING_TLS_TRUST_STORE_PASSWORD, SETTING_TOKEN, SETTING_URL, SETTING_USE_TLS, SETTING_USERNAME

Constructor Summary

Constructors

Constructor and Description
GraphiteWriter()

Method Summary

Modifier and Type	Method and Description
void	start() Load settings, initialize the SocketWriter pool and test the connection to the graphite server.
void	stop() Close the SocketWriter pool.
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, 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

Field Detail

DEFAULT_GRAPHITE_SERVER_PORT

public static final int DEFAULT_GRAPHITE_SERVER_PORT

See Also:

Constant Field Values

DEFAULT_NAME_PREFIX

public static final String DEFAULT_NAME_PREFIX

See Also:

Constant Field Values

Constructor Detail

GraphiteWriter

public GraphiteWriter()

Method Detail

start

public void start()

Load settings, initialize the SocketWriter pool and test the connection to the graphite server. A Logger.warn(String) message is emitted if the connection to the graphite server fails.

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

stop

public void stop()
          throws Exception

Close the SocketWriter pool.

Specified by:

stop in interface OutputWriter

Overrides:

stop in class AbstractOutputWriter

Throws:

Exception