com.timgroup.statsd

Class NonBlockingStatsDClient

java.lang.Object

com.timgroup.statsd.NonBlockingStatsDClient

All Implemented Interfaces:

StatsDClient

public final class NonBlockingStatsDClient
extends Object
implements StatsDClient

A simple StatsD client implementation facilitating metrics recording.

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

Three key methods are provided for the submission of data-points for the application under scrutiny:

• incrementCounter(java.lang.String, java.lang.String...) - adds one to the value of the specified named counter
• recordGaugeValue(java.lang.String, double, java.lang.String...) - records the latest fixed value for the specified named gauge
• recordExecutionTime(java.lang.String, long, java.lang.String...) - records an execution time in milliseconds for the specified named operation
• recordHistogramValue(java.lang.String, double, java.lang.String...) - records a value, to be tracked with average, maximum, and percentiles
• recordEvent(com.timgroup.statsd.Event, java.lang.String...) - records an event
• recordSetValue(java.lang.String, java.lang.String, java.lang.String...) - records a value in a set

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:

Tom Denley

Field Summary

Fields

Modifier and Type	Field and Description
static Charset	MESSAGE_CHARSET

Constructor Summary

Constructors

Constructor and Description
NonBlockingStatsDClient(String prefix, int queueSize, String[] constantTags, StatsDClientErrorHandler errorHandler, Callable<InetSocketAddress> addressLookup) Create a new StatsD client communicating with a StatsD instance on the specified host and port.
NonBlockingStatsDClient(String prefix, String hostname, int port) Create a new StatsD client communicating with a StatsD instance on the specified host and port.
NonBlockingStatsDClient(String prefix, String hostname, int port, int queueSize) Create a new StatsD client communicating with a StatsD instance on the specified host and port.
NonBlockingStatsDClient(String prefix, String hostname, int port, int queueSize, String... constantTags) Create a new StatsD client communicating with a StatsD instance on the specified host and port.
NonBlockingStatsDClient(String prefix, String hostname, int port, int queueSize, String[] constantTags, StatsDClientErrorHandler errorHandler) Create a new StatsD client communicating with a StatsD instance on the specified host and port.
NonBlockingStatsDClient(String prefix, String hostname, int port, String... constantTags) Create a new StatsD client communicating with a StatsD instance on the specified host and port.
NonBlockingStatsDClient(String prefix, 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
void	count(String aspect, long delta, String... tags) Adjusts the specified counter by a given delta.
void	decrement(String aspect, String... tags) Convenience method equivalent to decrementCounter(String, String[]).
void	decrementCounter(String aspect, String... tags) Decrements the specified counter by one.
void	gauge(String aspect, double value, String... tags) Convenience method equivalent to recordGaugeValue(String, double, String[]).
void	gauge(String aspect, long value, String... tags) Convenience method equivalent to recordGaugeValue(String, long, String[]).
void	histogram(String aspect, double value, String... tags) Convenience method equivalent to recordHistogramValue(String, double, String[]).
void	histogram(String aspect, long value, String... tags) Convenience method equivalent to recordHistogramValue(String, long, String[]).
void	increment(String aspect, String... tags) Convenience method equivalent to incrementCounter(String, String[]).
void	incrementCounter(String aspect, String... tags) Increments the specified counter by one.
void	recordEvent(Event event, String... tags) Records an event
void	recordExecutionTime(String aspect, long timeInMs, String... tags) Records an execution time in milliseconds for the specified named operation.
void	recordGaugeValue(String aspect, double value, String... tags) Records the latest fixed value for the specified named gauge.
void	recordGaugeValue(String aspect, long value, String... tags) Records the latest fixed value for the specified named gauge.
void	recordHistogramValue(String aspect, double value, String... tags) Records a value for the specified named histogram.
void	recordHistogramValue(String aspect, long value, String... tags) Records a value for the specified named histogram.
void	recordServiceCheckRun(ServiceCheck sc) Records a run status for the specified named service check.
void	recordSetValue(String aspect, String value, String... tags) Records a value for the specified set.
void	serviceCheck(ServiceCheck sc) Convenience method equivalent to recordServiceCheckRun(ServiceCheck sc).
static Callable<InetSocketAddress>	staticAddressResolution(String hostname, int port) Lookup the address for the given host name and cache the result.
void	stop() Cleanly shut down this StatsD client.
void	time(String aspect, long value, String... tags) Convenience method equivalent to recordExecutionTime(String, long, String[]).
static Callable<InetSocketAddress>	volatileAddressResolution(String hostname, int port) Create dynamic lookup for the given host name and port.

Methods inherited from class java.lang.Object

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

Field Detail

MESSAGE_CHARSET

public static final Charset MESSAGE_CHARSET

Constructor Detail

NonBlockingStatsDClient

public NonBlockingStatsDClient(String prefix,
                       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:

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

Throws:

StatsDClientException - if the client could not be started

NonBlockingStatsDClient

public NonBlockingStatsDClient(String prefix,
                       String hostname,
                       int port,
                       int queueSize)
                        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:

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

queueSize - the maximum amount of unprocessed messages in the BlockingQueue.

Throws:

StatsDClientException - if the client could not be started

NonBlockingStatsDClient

public NonBlockingStatsDClient(String prefix,
                       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:

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

Throws:

StatsDClientException - if the client could not be started

NonBlockingStatsDClient

public NonBlockingStatsDClient(String prefix,
                       String hostname,
                       int port,
                       int queueSize,
                       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:

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

queueSize - the maximum amount of unprocessed messages in the BlockingQueue.

Throws:

StatsDClientException - if the client could not be started

NonBlockingStatsDClient

public NonBlockingStatsDClient(String prefix,
                       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

errorHandler - handler to use when an exception occurs during usage, may be null to indicate noop

Throws:

StatsDClientException - if the client could not be started

NonBlockingStatsDClient

public NonBlockingStatsDClient(String prefix,
                       String hostname,
                       int port,
                       int queueSize,
                       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

errorHandler - handler to use when an exception occurs during usage, may be null to indicate noop

queueSize - the maximum amount of unprocessed messages in the BlockingQueue.

Throws:

StatsDClientException - if the client could not be started

NonBlockingStatsDClient

public NonBlockingStatsDClient(String prefix,
                       int queueSize,
                       String[] constantTags,
                       StatsDClientErrorHandler errorHandler,
                       Callable<InetSocketAddress> addressLookup)
                        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

constantTags - tags to be added to all content sent

errorHandler - handler to use when an exception occurs during usage, may be null to indicate noop

addressLookup - yields the IP address and socket of the StatsD server

queueSize - the maximum amount of unprocessed messages in the BlockingQueue.

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.

Specified by:

stop in interface StatsDClient

count

public void count(String aspect,
         long delta,
         String... tags)

Adjusts the specified counter by a given delta.

This method is non-blocking and is guaranteed not to throw an exception.

Specified by:

count in interface StatsDClient

Parameters:

aspect - the name of the counter to adjust

delta - the amount to adjust the counter by

tags - array of tags to be added to the data

incrementCounter

public void incrementCounter(String aspect,
                    String... tags)

Increments the specified counter by one.

This method is non-blocking and is guaranteed not to throw an exception.

Specified by:

incrementCounter in interface StatsDClient

Parameters:

aspect - the name of the counter to increment

tags - array of tags to be added to the data

increment

public void increment(String aspect,
             String... tags)

Convenience method equivalent to incrementCounter(String, String[]).

Specified by:

increment in interface StatsDClient

decrementCounter

public void decrementCounter(String aspect,
                    String... tags)

Decrements the specified counter by one.

This method is non-blocking and is guaranteed not to throw an exception.

Specified by:

decrementCounter in interface StatsDClient

Parameters:

aspect - the name of the counter to decrement

tags - array of tags to be added to the data

decrement

public void decrement(String aspect,
             String... tags)

Convenience method equivalent to decrementCounter(String, String[]).

Specified by:

decrement in interface StatsDClient

recordGaugeValue

public void recordGaugeValue(String aspect,
                    double value,
                    String... tags)

Records the latest fixed value for the specified named gauge.

This method is non-blocking and is guaranteed not to throw an exception.

Specified by:

recordGaugeValue in interface StatsDClient

Parameters:

aspect - the name of the gauge

value - the new reading of the gauge

tags - array of tags to be added to the data

gauge

public void gauge(String aspect,
         double value,
         String... tags)

Convenience method equivalent to recordGaugeValue(String, double, String[]).

Specified by:

gauge in interface StatsDClient

recordGaugeValue

public void recordGaugeValue(String aspect,
                    long value,
                    String... tags)

Records the latest fixed value for the specified named gauge.

This method is non-blocking and is guaranteed not to throw an exception.

Specified by:

recordGaugeValue in interface StatsDClient

Parameters:

aspect - the name of the gauge

value - the new reading of the gauge

tags - array of tags to be added to the data

gauge

public void gauge(String aspect,
         long value,
         String... tags)

Convenience method equivalent to recordGaugeValue(String, long, String[]).

Specified by:

gauge in interface StatsDClient

recordExecutionTime

public void recordExecutionTime(String aspect,
                       long timeInMs,
                       String... tags)

Records an execution time in milliseconds for the specified named operation.

This method is non-blocking and is guaranteed not to throw an exception.

Specified by:

recordExecutionTime in interface StatsDClient

Parameters:

aspect - the name of the timed operation

timeInMs - the time in milliseconds

tags - array of tags to be added to the data

time

public void time(String aspect,
        long value,
        String... tags)

Convenience method equivalent to recordExecutionTime(String, long, String[]).

Specified by:

time in interface StatsDClient

recordHistogramValue

public void recordHistogramValue(String aspect,
                        double value,
                        String... tags)

Records a value for the specified named histogram.

This method is non-blocking and is guaranteed not to throw an exception.

Specified by:

recordHistogramValue in interface StatsDClient

Parameters:

aspect - the name of the histogram

value - the value to be incorporated in the histogram

tags - array of tags to be added to the data

histogram

public void histogram(String aspect,
             double value,
             String... tags)

Convenience method equivalent to recordHistogramValue(String, double, String[]).

Specified by:

histogram in interface StatsDClient

recordHistogramValue

public void recordHistogramValue(String aspect,
                        long value,
                        String... tags)

Records a value for the specified named histogram.

This method is non-blocking and is guaranteed not to throw an exception.

Specified by:

recordHistogramValue in interface StatsDClient

Parameters:

aspect - the name of the histogram

value - the value to be incorporated in the histogram

tags - array of tags to be added to the data

histogram

public void histogram(String aspect,
             long value,
             String... tags)

Convenience method equivalent to recordHistogramValue(String, long, String[]).

Specified by:

histogram in interface StatsDClient

recordEvent

public void recordEvent(Event event,
               String... tags)

Records an event

This method is a DataDog extension, and may not work with other servers.

This method is non-blocking and is guaranteed not to throw an exception.

Specified by:

recordEvent in interface StatsDClient

Parameters:

event - The event to record

tags - array of tags to be added to the data

See Also:

http://docs.datadoghq.com/guides/dogstatsd/#events-1

recordServiceCheckRun

public void recordServiceCheckRun(ServiceCheck sc)

Records a run status for the specified named service check.

This method is a DataDog extension, and may not work with other servers.

This method is non-blocking and is guaranteed not to throw an exception.

Specified by:

recordServiceCheckRun in interface StatsDClient

Parameters:

sc - the service check object

serviceCheck

public void serviceCheck(ServiceCheck sc)

Convenience method equivalent to recordServiceCheckRun(ServiceCheck sc).

Specified by:

serviceCheck in interface StatsDClient

recordSetValue

public void recordSetValue(String aspect,
                  String value,
                  String... tags)

Records a value for the specified set. Sets are used to count the number of unique elements in a group. If you want to track the number of unique visitor to your site, sets are a great way to do that.

This method is a DataDog extension, and may not work with other servers.

This method is non-blocking and is guaranteed not to throw an exception.

Specified by:

recordSetValue in interface StatsDClient

Parameters:

aspect - the name of the set

value - the value to track

tags - array of tags to be added to the data

See Also:

http://docs.datadoghq.com/guides/dogstatsd/#sets

volatileAddressResolution

public static Callable<InetSocketAddress> volatileAddressResolution(String hostname,
                                                    int port)

Create dynamic lookup for the given host name and port.

Parameters:

hostname - the host name of the targeted StatsD server

port - the port of the targeted StatsD server

Returns:

a function to perform the lookup

See Also:

NonBlockingStatsDClient#NonBlockingStatsDClient(String, String[], StatsDClientErrorHandler, Callable)

staticAddressResolution

public static Callable<InetSocketAddress> staticAddressResolution(String hostname,
                                                  int port)
                                                           throws Exception

Lookup the address for the given host name and cache the result.

Parameters:

hostname - the host name of the targeted StatsD server

port - the port of the targeted StatsD server

Returns:

a function that cached the result of the lookup

Throws:

Exception - if the lookup fails, i.e. UnknownHostException