com.github.arnabk.statsd

Class BlockingStatsDEventClient

java.lang.Object

com.github.arnabk.statsd.BlockingStatsDEventClient

Direct Known Subclasses:

NonBlockingStatsDEventClient

public class BlockingStatsDEventClient
extends Object

A simple StatsD client implementation facilitating event reporting.

Upon instantiation, this client will establish a socket connection to a StatsD instance running on the specified host and port. Events are then sent over this connection as they are received by the client.

Six key methods are provided for the submission of events for the application under scrutiny:

• event(String, String)
• event(String, String, AlertType)
• event(String, String, long)
• event(String, String, Priority)
• event(String, String, String...)
• event(String, String, long, String, Priority, String, AlertType, String...)

From the perspective of the application, these methods are blocking.

As part of a clean system shutdown, the stop() method should be invoked on any StatsD clients.

Author:

Arnab Karmakar

Field Summary

Fields

Modifier and Type	Field and Description
protected DatagramSocket	clientSocket
protected String[]	constantTags
protected StatsDClientErrorHandler	handler
protected String	hostname
protected static ThreadLocal<NumberFormat>	NUMBER_FORMATTERS Because NumberFormat is not thread-safe we cannot share instances across threads.

Constructor Summary

Constructors

Constructor and Description
BlockingStatsDEventClient(String hostname, int port) Create a new StatsD client communicating with a StatsD instance on the specified host and port.
BlockingStatsDEventClient(String hostname, int port, String[] constantTags) Create a new StatsD client communicating with a StatsD instance on the specified host and port.
BlockingStatsDEventClient(String hostname, int port, String[] constantTags, StatsDClientErrorHandler errorHandler) Create a new StatsD client communicating with a StatsD instance on the specified host and port.

Method Summary

Methods

Modifier and Type	Method and Description
protected void	blockingSend(String message)
void	event(String title, String message) Submit event with title and message
void	event(String title, String message, AlertType alertType) Submit event with title, message and alter type
void	event(String title, String message, long dateHappened) Submit event with title, message and a time
void	event(String title, String message, long dateHappened, String aggregationKey, Priority priority, String sourceTypeName, AlertType alterType, String... tags) Reports an event to the datadog agent
void	event(String title, String message, Priority priority) Submit event with title, message and priority for the message
void	event(String title, String message, String... tags) Submit message with title, message and tags
protected String	prepareMessage(String title, String message, long dateHappened, String aggregationKey, Priority priority, String sourceTypeName, AlertType alterType, String... tags)
void	stop() Cleanly shut down this StatsD client.
protected String	tagString(String[] tags) Generate a suffix conveying the given tag list to the client

Methods inherited from class java.lang.Object

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

Field Detail

NUMBER_FORMATTERS

protected static final ThreadLocal<NumberFormat> NUMBER_FORMATTERS

Because NumberFormat is not thread-safe we cannot share instances across threads. Use a ThreadLocal to create one pre thread as this seems to offer a significant performance improvement over creating one per-thread: http://stackoverflow.com/a/1285297/2648 https://github.com/indeedeng/java-dogstatsd-client/issues/4

clientSocket

protected final DatagramSocket clientSocket

handler

protected final StatsDClientErrorHandler handler

constantTags

protected final String[] constantTags

hostname

protected final String hostname

Constructor Detail

BlockingStatsDEventClient

public BlockingStatsDEventClient(String hostname,
                         int port)
                          throws StatsDClientException

Create a new StatsD client communicating with a StatsD instance on the specified host and port. All messages send via this client will have their keys prefixed with the specified string. The new client will attempt to open a connection to the StatsD server immediately upon instantiation, and may throw an exception if that a connection cannot be established. Once a client has been instantiated in this way, all exceptions thrown during subsequent usage are consumed, guaranteeing that failures in metrics will not affect normal code execution.

Parameters:

hostname - the host name of the targeted StatsD server

port - the port of the targeted StatsD server

Throws:

StatsDClientException - if the client could not be started

BlockingStatsDEventClient

public BlockingStatsDEventClient(String hostname,
                         int port,
                         String[] constantTags)
                          throws StatsDClientException

Create a new StatsD client communicating with a StatsD instance on the specified host and port. All messages send via this client will have their keys prefixed with the specified string. The new client will attempt to open a connection to the StatsD server immediately upon instantiation, and may throw an exception if that a connection cannot be established. Once a client has been instantiated in this way, all exceptions thrown during subsequent usage are consumed, guaranteeing that failures in metrics will not affect normal code execution.

Parameters:

hostname - the host name of the targeted StatsD server

port - the port of the targeted StatsD server

constantTags - tags to be added to all content sent (each of them should be in the format key:value)

Throws:

StatsDClientException - if the client could not be started

BlockingStatsDEventClient

public BlockingStatsDEventClient(String hostname,
                         int port,
                         String[] constantTags,
                         StatsDClientErrorHandler errorHandler)
                          throws StatsDClientException

Create a new StatsD client communicating with a StatsD instance on the specified host and port. All messages send via this client will have their keys prefixed with the specified string. The new client will attempt to open a connection to the StatsD server immediately upon instantiation, and may throw an exception if that a connection cannot be established. Once a client has been instantiated in this way, all exceptions thrown during subsequent usage are passed to the specified handler and then consumed, guaranteeing that failures in metrics will not affect normal code execution.

Parameters:

prefix - the prefix to apply to keys sent via this client

hostname - the host name of the targeted StatsD server

port - the port of the targeted StatsD server

constantTags - tags to be added to all content sent (each of them should be in the format key:value)

errorHandler - handler to use when an exception occurs during usage

Throws:

StatsDClientException - if the client could not be started

Method Detail

stop

public void stop()

Cleanly shut down this StatsD client. This method may throw an exception if the socket cannot be closed.

tagString

protected String tagString(String[] tags)

Generate a suffix conveying the given tag list to the client

Parameters:

tags -

Returns:

event

public void event(String title,
         String message)

Submit event with title and message

Parameters:

title -

message -

event

public void event(String title,
         String message,
         long dateHappened)

Submit event with title, message and a time

Parameters:

title -

message -

dateHappened - - It should be in seconds

event

public void event(String title,
         String message,
         Priority priority)

Submit event with title, message and priority for the message

Parameters:

title -

message -

priority -

event

public void event(String title,
         String message,
         AlertType alertType)

Submit event with title, message and alter type

Parameters:

title -

message -

alertType -

event

public void event(String title,
         String message,
         String... tags)

Submit message with title, message and tags

Parameters:

title -

message -

tags -

event

public void event(String title,
         String message,
         long dateHappened,
         String aggregationKey,
         Priority priority,
         String sourceTypeName,
         AlertType alterType,
         String... tags)

Reports an event to the datadog agent

Parameters:

title -

message -

dateHappened -

aggregationKey -

priority -

sourceTypeName -

alterType -

tags - -> Each item in this array should in the format key:value

prepareMessage

protected String prepareMessage(String title,
                    String message,
                    long dateHappened,
                    String aggregationKey,
                    Priority priority,
                    String sourceTypeName,
                    AlertType alterType,
                    String... tags)

blockingSend

protected void blockingSend(String message)