com.github.arnabk.statsd

Class NonBlockingStatsDEventClient

java.lang.Object

com.github.arnabk.statsd.BlockingStatsDEventClient

com.github.arnabk.statsd.NonBlockingStatsDEventClient

public final class NonBlockingStatsDEventClient
extends BlockingStatsDEventClient

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:

• BlockingStatsDEventClient.event(String, String) - inherited from base class BlockingStatsDEventClient
• BlockingStatsDEventClient.event(String, String, AlertType) - inherited from base class BlockingStatsDEventClient
• BlockingStatsDEventClient.event(String, String, long) - inherited from base class BlockingStatsDEventClient
• BlockingStatsDEventClient.event(String, String, Priority) - inherited from base class BlockingStatsDEventClient
• BlockingStatsDEventClient.event(String, String, String...) - inherited from base class BlockingStatsDEventClient
• event(String, String, long, String, Priority, String, AlertType, String...) - overriding from base class BlockingStatsDEventClient and converting it to non-blocking

From the perspective of the application, these methods are non-blocking, with the resulting IO operations being carried out in a separate thread. Furthermore, these methods are guaranteed not to throw an exception which may disrupt application execution.

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

Author:

Arnab Karmakar

Field Summary

Fields inherited from class com.github.arnabk.statsd.BlockingStatsDEventClient

clientSocket, constantTags, handler, hostname

Constructor Summary

Constructors

Constructor and Description
NonBlockingStatsDEventClient(String hostname, int port) Create a new StatsD client communicating with a StatsD instance on the specified host and port.
NonBlockingStatsDEventClient(String hostname, int port, String[] constantTags) Create a new StatsD client communicating with a StatsD instance on the specified host and port.
NonBlockingStatsDEventClient(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

Modifier and Type	Method and Description
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 (non-blocking)
void	stop() Cleanly shut down this StatsD client.

Methods inherited from class com.github.arnabk.statsd.BlockingStatsDEventClient

blockingSend, event, event, event, event, event, prepareMessage, tagString

Methods inherited from class java.lang.Object

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

Constructor Detail

NonBlockingStatsDEventClient

public NonBlockingStatsDEventClient(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

NonBlockingStatsDEventClient

public NonBlockingStatsDEventClient(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

NonBlockingStatsDEventClient

public NonBlockingStatsDEventClient(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.

Overrides:

stop in class BlockingStatsDEventClient

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 (non-blocking)

Overrides:

event in class BlockingStatsDEventClient

Parameters:

title -

message -

dateHappened -

aggregationKey -

priority -

sourceTypeName -

alterType -

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