NonBlockingStatsDClient (java-dogstatsd-client 4.0.0 API)

java.lang.Object
- com.timgroup.statsd.NonBlockingStatsDClient

All Implemented Interfaces:

StatsDClient, Closeable, AutoCloseable
```
public 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 String`	`CLIENT_TAG`
`static String`	`CLIENT_TRANSPORT_TAG`
`static String`	`CLIENT_VERSION_TAG`
`static String`	`DD_AGENT_HOST_ENV_VAR`
`static String`	`DD_DOGSTATSD_PORT_ENV_VAR`
`static String`	`DD_ENTITY_ID_ENV_VAR`
`static String`	`DD_NAMED_PIPE_ENV_VAR`
`static boolean`	`DEFAULT_BLOCKING`
`static int`	`DEFAULT_DOGSTATSD_PORT`
`static boolean`	`DEFAULT_ENABLE_AGGREGATION`
`static boolean`	`DEFAULT_ENABLE_TELEMETRY`
`static int`	`DEFAULT_POOL_SIZE`
`static int`	`DEFAULT_PROCESSOR_WORKERS`
`static int`	`DEFAULT_QUEUE_SIZE`
`static int`	`DEFAULT_SENDER_WORKERS`
`static int`	`DEFAULT_UDP_MAX_PACKET_SIZE_BYTES`
`static int`	`DEFAULT_UDS_MAX_PACKET_SIZE_BYTES`
`protected static ThreadLocal<NumberFormat>`	`NUMBER_FORMATTER` The NumberFormat instances are not threadsafe and thus defined as ThreadLocal for safety.
`protected static ThreadLocal<NumberFormat>`	`SAMPLE_RATE_FORMATTER`
`static int`	`SOCKET_BUFFER_BYTES`
`static int`	`SOCKET_TIMEOUT_MS`
`protected StatsDProcessor`	`statsDProcessor`
`protected StatsDSender`	`statsDSender`
`protected Telemetry`	`telemetry`
`protected StatsDProcessor`	`telemetryStatsDProcessor`
`protected StatsDSender`	`telemetryStatsDSender`
`static Charset`	`UTF_8` UTF-8 is the expected encoding for data sent to the agent.

Constructor Summary

Constructors
Constructor and Description
`NonBlockingStatsDClient(NonBlockingStatsDClientBuilder builder)` Create a new StatsD client communicating with a StatsD instance on the host and port specified by the given builder.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`close()` Stop the statsd client.
`void`	`count(String aspect, double delta, double sampleRate, String... tags)` Adjusts the specified counter by a given delta.
`void`	`count(String aspect, double delta, String... tags)` Adjusts the specified counter by a given delta.
`void`	`count(String aspect, long delta, double sampleRate, String... tags)` Adjusts the specified counter by a given delta.
`void`	`count(String aspect, long delta, String... tags)` Adjusts the specified counter by a given delta.
`protected StatsDProcessor`	`createProcessor(int queueSize, StatsDClientErrorHandler handler, int maxPacketSizeBytes, int bufferPoolSize, int workers, boolean blocking, int aggregationFlushInterval, int aggregationShards, ThreadFactory threadFactory)`
`protected StatsDSender`	`createSender(StatsDClientErrorHandler handler, WritableByteChannel clientChannel, BufferPool pool, BlockingQueue<ByteBuffer> buffers, int senderWorkers, ThreadFactory threadFactory)`
`void`	`decrement(String aspect, double sampleRate, String... tags)` Convenience method equivalent to `StatsDClient.decrementCounter(String, double, String[])`.
`void`	`decrement(String aspect, String... tags)` Convenience method equivalent to `decrementCounter(String, String[])`.
`void`	`decrementCounter(String aspect, double sampleRate, String... tags)` Decrements the specified counter by one.
`void`	`decrementCounter(String aspect, String... tags)` Decrements the specified counter by one.
`void`	`distribution(String aspect, double value, double sampleRate, String... tags)` Convenience method equivalent to `StatsDClient.recordDistributionValue(String, double, double, String[])`.
`void`	`distribution(String aspect, double value, String... tags)` Convenience method equivalent to `recordDistributionValue(String, double, String[])`.
`void`	`distribution(String aspect, long value, double sampleRate, String... tags)` Convenience method equivalent to `StatsDClient.recordDistributionValue(String, long, double, String[])`.
`void`	`distribution(String aspect, long value, String... tags)` Convenience method equivalent to `recordDistributionValue(String, long, String[])`.
`protected static String`	`format(ThreadLocal<NumberFormat> formatter, Number value)`
`void`	`gauge(String aspect, double value, double sampleRate, String... tags)` Convenience method equivalent to `StatsDClient.recordGaugeValue(String, double, double, String[])`.
`void`	`gauge(String aspect, double value, String... tags)` Convenience method equivalent to `recordGaugeValue(String, double, String[])`.
`void`	`gauge(String aspect, long value, double sampleRate, String... tags)` Convenience method equivalent to `StatsDClient.recordGaugeValue(String, long, double, String[])`.
`void`	`gauge(String aspect, long value, String... tags)` Convenience method equivalent to `recordGaugeValue(String, long, String[])`.
`void`	`histogram(String aspect, double value, double sampleRate, String... tags)` Convenience method equivalent to `StatsDClient.recordHistogramValue(String, double, double, String[])`.
`void`	`histogram(String aspect, double value, String... tags)` Convenience method equivalent to `recordHistogramValue(String, double, String[])`.
`void`	`histogram(String aspect, long value, double sampleRate, String... tags)` Convenience method equivalent to `StatsDClient.recordHistogramValue(String, long, double, String[])`.
`void`	`histogram(String aspect, long value, String... tags)` Convenience method equivalent to `recordHistogramValue(String, long, String[])`.
`void`	`increment(String aspect, double sampleRate, String... tags)` Convenience method equivalent to `StatsDClient.incrementCounter(String, double, String[])`.
`void`	`increment(String aspect, String... tags)` Convenience method equivalent to `incrementCounter(String, String[])`.
`void`	`incrementCounter(String aspect, double sampleRate, String... tags)` Increments the specified counter by one.
`void`	`incrementCounter(String aspect, String... tags)` Increments the specified counter by one.
`protected boolean`	`isInvalidSample(double sampleRate)`
`void`	`recordDistributionValue(String aspect, double value, double sampleRate, String... tags)` Records a value for the specified named distribution.
`void`	`recordDistributionValue(String aspect, double value, String... tags)` Records a value for the specified named distribution.
`void`	`recordDistributionValue(String aspect, long value, double sampleRate, String... tags)` Records a value for the specified named distribution.
`void`	`recordDistributionValue(String aspect, long value, String... tags)` Records a value for the specified named distribution.
`void`	`recordEvent(Event event, String... eventTags)` Records an event.
`void`	`recordExecutionTime(String aspect, long timeInMs, double sampleRate, String... tags)` Records an execution time in milliseconds for the specified named operation.
`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, double sampleRate, String... tags)` Records the latest fixed value for the specified named gauge.
`void`	`recordGaugeValue(String aspect, double value, String... tags)` Records the latest fixed value for the specified named gauge.
`void`	`recordGaugeValue(String aspect, long value, double sampleRate, 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, double sampleRate, String... tags)` Records a value for the specified named histogram.
`void`	`recordHistogramValue(String aspect, double value, String... tags)` Records a value for the specified named histogram.
`void`	`recordHistogramValue(String aspect, long value, double sampleRate, 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 val, String... tags)` Records a value for the specified set.
`void`	`serviceCheck(ServiceCheck sc)` Convenience method equivalent to `recordServiceCheckRun(ServiceCheck sc)`.
`void`	`stop()` Cleanly shut down this StatsD client.
`void`	`time(String aspect, long value, double sampleRate, String... tags)` Convenience method equivalent to `StatsDClient.recordExecutionTime(String, long, double, String[])`.
`void`	`time(String aspect, long value, String... tags)` Convenience method equivalent to `recordExecutionTime(String, long, String[])`.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - DD_DOGSTATSD_PORT_ENV_VAR
```
public static final String DD_DOGSTATSD_PORT_ENV_VAR
```
    See Also:
    
    Constant Field Values
  - DD_AGENT_HOST_ENV_VAR
```
public static final String DD_AGENT_HOST_ENV_VAR
```
    See Also:
    
    Constant Field Values
  - DD_NAMED_PIPE_ENV_VAR
```
public static final String DD_NAMED_PIPE_ENV_VAR
```
    See Also:
    
    Constant Field Values
  - DD_ENTITY_ID_ENV_VAR
```
public static final String DD_ENTITY_ID_ENV_VAR
```
    See Also:
    
    Constant Field Values
  - DEFAULT_UDP_MAX_PACKET_SIZE_BYTES
```
public static final int DEFAULT_UDP_MAX_PACKET_SIZE_BYTES
```
    See Also:
    
    Constant Field Values
  - DEFAULT_UDS_MAX_PACKET_SIZE_BYTES
```
public static final int DEFAULT_UDS_MAX_PACKET_SIZE_BYTES
```
    See Also:
    
    Constant Field Values
  - DEFAULT_QUEUE_SIZE
```
public static final int DEFAULT_QUEUE_SIZE
```
    See Also:
    
    Constant Field Values
  - DEFAULT_POOL_SIZE
```
public static final int DEFAULT_POOL_SIZE
```
    See Also:
    
    Constant Field Values
  - DEFAULT_PROCESSOR_WORKERS
```
public static final int DEFAULT_PROCESSOR_WORKERS
```
    See Also:
    
    Constant Field Values
  - DEFAULT_SENDER_WORKERS
```
public static final int DEFAULT_SENDER_WORKERS
```
    See Also:
    
    Constant Field Values
  - DEFAULT_DOGSTATSD_PORT
```
public static final int DEFAULT_DOGSTATSD_PORT
```
    See Also:
    
    Constant Field Values
  - SOCKET_TIMEOUT_MS
```
public static final int SOCKET_TIMEOUT_MS
```
    See Also:
    
    Constant Field Values
  - SOCKET_BUFFER_BYTES
```
public static final int SOCKET_BUFFER_BYTES
```
    See Also:
    
    Constant Field Values
  - DEFAULT_BLOCKING
```
public static final boolean DEFAULT_BLOCKING
```
    See Also:
    
    Constant Field Values
  - DEFAULT_ENABLE_TELEMETRY
```
public static final boolean DEFAULT_ENABLE_TELEMETRY
```
    See Also:
    
    Constant Field Values
  - DEFAULT_ENABLE_AGGREGATION
```
public static final boolean DEFAULT_ENABLE_AGGREGATION
```
    See Also:
    
    Constant Field Values
  - CLIENT_TAG
```
public static final String CLIENT_TAG
```
    See Also:
    
    Constant Field Values
  - CLIENT_VERSION_TAG
```
public static final String CLIENT_VERSION_TAG
```
    See Also:
    
    Constant Field Values
  - CLIENT_TRANSPORT_TAG
```
public static final String CLIENT_TRANSPORT_TAG
```
    See Also:
    
    Constant Field Values
  - UTF_8
```
public static final Charset UTF_8
```
    UTF-8 is the expected encoding for data sent to the agent.
  - NUMBER_FORMATTER
```
protected static final ThreadLocal<NumberFormat> NUMBER_FORMATTER
```
    The NumberFormat instances are not threadsafe and thus defined as ThreadLocal for safety.
  - SAMPLE_RATE_FORMATTER
```
protected static final ThreadLocal<NumberFormat> SAMPLE_RATE_FORMATTER
```
  - statsDProcessor
```
protected final StatsDProcessor statsDProcessor
```
  - telemetryStatsDProcessor
```
protected StatsDProcessor telemetryStatsDProcessor
```
  - statsDSender
```
protected final StatsDSender statsDSender
```
  - telemetryStatsDSender
```
protected StatsDSender telemetryStatsDSender
```
  - telemetry
```
protected final Telemetry telemetry
```
- Constructor Detail
  - NonBlockingStatsDClient
```
public NonBlockingStatsDClient(NonBlockingStatsDClientBuilder builder)
                        throws StatsDClientException
```
    Create a new StatsD client communicating with a StatsD instance on the host and port specified by the given builder. The builder must be resolved before calling this internal constructor.
    
    Parameters:
    
    builder - the resolved configuration builder
    
    Throws:
    
    StatsDClientException
    
    See Also:
    
    NonBlockingStatsDClientBuilder.resolve()
- Method Detail
  - format
```
protected static String format(ThreadLocal<NumberFormat> formatter,
                               Number value)
```
  - createProcessor
```
protected StatsDProcessor createProcessor(int queueSize,
                                          StatsDClientErrorHandler handler,
                                          int maxPacketSizeBytes,
                                          int bufferPoolSize,
                                          int workers,
                                          boolean blocking,
                                          int aggregationFlushInterval,
                                          int aggregationShards,
                                          ThreadFactory threadFactory)
                                   throws Exception
```
    Throws:
    
    Exception
  - createSender
```
protected StatsDSender createSender(StatsDClientErrorHandler handler,
                                    WritableByteChannel clientChannel,
                                    BufferPool pool,
                                    BlockingQueue<ByteBuffer> buffers,
                                    int senderWorkers,
                                    ThreadFactory threadFactory)
                             throws Exception
```
    Throws:
    
    Exception
  - stop
```
public void stop()
```
    Cleanly shut down this StatsD client. This method may throw an exception if the socket cannot be closed.
    In blocking mode, this will block until all messages are sent to the server.
    
    Specified by:
    
    stop in interface StatsDClient
  - close
```
public void close()
```
    Description copied from interface: StatsDClient
    
    Stop the statsd client.
    
    Specified by:
    
    close in interface StatsDClient
    
    Specified by:
    
    close in interface Closeable
    
    Specified by:
    
    close in interface AutoCloseable
    
    See Also:
    
    StatsDClient.stop()
  - 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
  - count
```
public void count(String aspect,
                  long delta,
                  double sampleRate,
                  String... tags)
```
    Adjusts the specified counter by a given delta.
    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:
    
    count in interface StatsDClient
    
    Parameters:
    
    aspect - the name of the counter to adjust
    
    delta - the amount to adjust the counter by
    
    sampleRate - percentage of time metric to be sent
    
    tags - array of tags to be added to the data
  - count
```
public void count(String aspect,
                  double 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
  - count
```
public void count(String aspect,
                  double delta,
                  double sampleRate,
                  String... tags)
```
    Adjusts the specified counter by a given delta.
    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:
    
    count in interface StatsDClient
    
    Parameters:
    
    aspect - the name of the counter to adjust
    
    delta - the amount to adjust the counter by
    
    sampleRate - percentage of time metric to be sent
    
    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
  - incrementCounter
```
public void incrementCounter(String aspect,
                             double sampleRate,
                             String... tags)
```
    Increments the specified counter by one.
    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:
    
    incrementCounter in interface StatsDClient
    
    Parameters:
    
    aspect - the name of the counter to increment
    
    sampleRate - percentage of time metric to be sent
    
    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
    
    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,
                      double sampleRate,
                      String... tags)
```
    Convenience method equivalent to StatsDClient.incrementCounter(String, double, String[]).
    
    Specified by:
    
    increment in interface StatsDClient
    
    Parameters:
    
    aspect - the name of the counter to increment
    
    sampleRate - percentage of time metric to be sent
    
    tags - array of tags to be added to the data
  - 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
  - decrementCounter
```
public void decrementCounter(String aspect,
                             double sampleRate,
                             String... tags)
```
    Decrements the specified counter by one.
    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:
    
    decrementCounter in interface StatsDClient
    
    Parameters:
    
    aspect - the name of the counter to decrement
    
    sampleRate - percentage of time metric to be sent
    
    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
    
    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,
                      double sampleRate,
                      String... tags)
```
    Convenience method equivalent to StatsDClient.decrementCounter(String, double, String[]).
    
    Specified by:
    
    decrement in interface StatsDClient
    
    Parameters:
    
    aspect - the name of the counter to decrement
    
    sampleRate - percentage of time metric to be sent
    
    tags - array of tags to be added to the data
  - 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
  - recordGaugeValue
```
public void recordGaugeValue(String aspect,
                             double value,
                             double sampleRate,
                             String... tags)
```
    Records the latest fixed value for the specified named gauge.
    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:
    
    recordGaugeValue in interface StatsDClient
    
    Parameters:
    
    aspect - the name of the gauge
    
    value - the new reading of the gauge
    
    sampleRate - percentage of time metric to be sent
    
    tags - array of tags to be added to the data
  - 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
  - recordGaugeValue
```
public void recordGaugeValue(String aspect,
                             long value,
                             double sampleRate,
                             String... tags)
```
    Records the latest fixed value for the specified named gauge.
    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:
    
    recordGaugeValue in interface StatsDClient
    
    Parameters:
    
    aspect - the name of the gauge
    
    value - the new reading of the gauge
    
    sampleRate - percentage of time metric to be sent
    
    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
    
    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,
                  double sampleRate,
                  String... tags)
```
    Convenience method equivalent to StatsDClient.recordGaugeValue(String, double, double, String[]).
    
    Specified by:
    
    gauge in interface StatsDClient
    
    Parameters:
    
    aspect - the name of the gauge
    
    value - the new reading of the gauge
    
    sampleRate - percentage of time metric to be sent
    
    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
    
    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,
                  double sampleRate,
                  String... tags)
```
    Convenience method equivalent to StatsDClient.recordGaugeValue(String, long, double, String[]).
    
    Specified by:
    
    gauge in interface StatsDClient
    
    Parameters:
    
    aspect - the name of the gauge
    
    value - the new reading of the gauge
    
    sampleRate - percentage of time metric to be sent
    
    tags - array of tags to be added to the data
  - 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
  - recordExecutionTime
```
public void recordExecutionTime(String aspect,
                                long timeInMs,
                                double sampleRate,
                                String... tags)
```
    Records an execution time in milliseconds for the specified named operation.
    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:
    
    recordExecutionTime in interface StatsDClient
    
    Parameters:
    
    aspect - the name of the timed operation
    
    timeInMs - the time in milliseconds
    
    sampleRate - percentage of time metric to be sent
    
    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
    
    Parameters:
    
    aspect - the name of the timed operation
    
    value - the time in milliseconds
    
    tags - array of tags to be added to the data
  - time
```
public void time(String aspect,
                 long value,
                 double sampleRate,
                 String... tags)
```
    Convenience method equivalent to StatsDClient.recordExecutionTime(String, long, double, String[]).
    
    Specified by:
    
    time in interface StatsDClient
    
    Parameters:
    
    aspect - the name of the timed operation
    
    value - the time in milliseconds
    
    sampleRate - percentage of time metric to be sent
    
    tags - array of tags to be added to the data
  - 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
  - recordHistogramValue
```
public void recordHistogramValue(String aspect,
                                 double value,
                                 double sampleRate,
                                 String... tags)
```
    Records a value for the specified named histogram.
    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:
    
    recordHistogramValue in interface StatsDClient
    
    Parameters:
    
    aspect - the name of the histogram
    
    value - the value to be incorporated in the histogram
    
    sampleRate - percentage of time metric to be sent
    
    tags - array of tags to be added to the data
  - 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
  - recordHistogramValue
```
public void recordHistogramValue(String aspect,
                                 long value,
                                 double sampleRate,
                                 String... tags)
```
    Records a value for the specified named histogram.
    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:
    
    recordHistogramValue in interface StatsDClient
    
    Parameters:
    
    aspect - the name of the histogram
    
    value - the value to be incorporated in the histogram
    
    sampleRate - percentage of time metric to be sent
    
    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
    
    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,
                      double sampleRate,
                      String... tags)
```
    Convenience method equivalent to StatsDClient.recordHistogramValue(String, double, double, String[]).
    
    Specified by:
    
    histogram in interface StatsDClient
    
    Parameters:
    
    aspect - the name of the histogram
    
    value - the value to be incorporated in the histogram
    
    sampleRate - percentage of time metric to be sent
    
    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
    
    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,
                      double sampleRate,
                      String... tags)
```
    Convenience method equivalent to StatsDClient.recordHistogramValue(String, long, double, String[]).
    
    Specified by:
    
    histogram in interface StatsDClient
    
    Parameters:
    
    aspect - the name of the histogram
    
    value - the value to be incorporated in the histogram
    
    sampleRate - percentage of time metric to be sent
    
    tags - array of tags to be added to the data
  - recordDistributionValue
```
public void recordDistributionValue(String aspect,
                                    double value,
                                    String... tags)
```
    Records a value for the specified named distribution.
    This method is non-blocking and is guaranteed not to throw an exception.
    
    Specified by:
    
    recordDistributionValue in interface StatsDClient
    
    Parameters:
    
    aspect - the name of the distribution
    
    value - the value to be incorporated in the distribution
    
    tags - array of tags to be added to the data
  - recordDistributionValue
```
public void recordDistributionValue(String aspect,
                                    double value,
                                    double sampleRate,
                                    String... tags)
```
    Records a value for the specified named distribution.
    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:
    
    recordDistributionValue in interface StatsDClient
    
    Parameters:
    
    aspect - the name of the distribution
    
    value - the value to be incorporated in the distribution
    
    sampleRate - percentage of time metric to be sent
    
    tags - array of tags to be added to the data
  - recordDistributionValue
```
public void recordDistributionValue(String aspect,
                                    long value,
                                    String... tags)
```
    Records a value for the specified named distribution.
    This method is non-blocking and is guaranteed not to throw an exception.
    
    Specified by:
    
    recordDistributionValue in interface StatsDClient
    
    Parameters:
    
    aspect - the name of the distribution
    
    value - the value to be incorporated in the distribution
    
    tags - array of tags to be added to the data
  - recordDistributionValue
```
public void recordDistributionValue(String aspect,
                                    long value,
                                    double sampleRate,
                                    String... tags)
```
    Records a value for the specified named distribution.
    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:
    
    recordDistributionValue in interface StatsDClient
    
    Parameters:
    
    aspect - the name of the distribution
    
    value - the value to be incorporated in the distribution
    
    sampleRate - percentage of time metric to be sent
    
    tags - array of tags to be added to the data
  - distribution
```
public void distribution(String aspect,
                         double value,
                         String... tags)
```
    Convenience method equivalent to recordDistributionValue(String, double, String[]).
    
    Specified by:
    
    distribution in interface StatsDClient
    
    Parameters:
    
    aspect - the name of the distribution
    
    value - the value to be incorporated in the distribution
    
    tags - array of tags to be added to the data
  - distribution
```
public void distribution(String aspect,
                         double value,
                         double sampleRate,
                         String... tags)
```
    Convenience method equivalent to StatsDClient.recordDistributionValue(String, double, double, String[]).
    
    Specified by:
    
    distribution in interface StatsDClient
    
    Parameters:
    
    aspect - the name of the distribution
    
    value - the value to be incorporated in the distribution
    
    sampleRate - percentage of time metric to be sent
    
    tags - array of tags to be added to the data
  - distribution
```
public void distribution(String aspect,
                         long value,
                         String... tags)
```
    Convenience method equivalent to recordDistributionValue(String, long, String[]).
    
    Specified by:
    
    distribution in interface StatsDClient
    
    Parameters:
    
    aspect - the name of the distribution
    
    value - the value to be incorporated in the distribution
    
    tags - array of tags to be added to the data
  - distribution
```
public void distribution(String aspect,
                         long value,
                         double sampleRate,
                         String... tags)
```
    Convenience method equivalent to StatsDClient.recordDistributionValue(String, long, double, String[]).
    
    Specified by:
    
    distribution in interface StatsDClient
    
    Parameters:
    
    aspect - the name of the distribution
    
    value - the value to be incorporated in the distribution
    
    sampleRate - percentage of time metric to be sent
    
    tags - array of tags to be added to the data
  - recordEvent
```
public void recordEvent(Event event,
                        String... eventTags)
```
    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
    
    eventTags - 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
    
    Parameters:
    
    sc - the service check object
  - recordSetValue
```
public void recordSetValue(String aspect,
                           String val,
                           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
    
    val - the value to track
    
    tags - array of tags to be added to the data
    
    See Also:
    
    http://docs.datadoghq.com/guides/dogstatsd/#sets
  - isInvalidSample
```
protected boolean isInvalidSample(double sampleRate)
```

Class NonBlockingStatsDClient

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DD_DOGSTATSD_PORT_ENV_VAR

DD_AGENT_HOST_ENV_VAR

DD_NAMED_PIPE_ENV_VAR

DD_ENTITY_ID_ENV_VAR

DEFAULT_UDP_MAX_PACKET_SIZE_BYTES

DEFAULT_UDS_MAX_PACKET_SIZE_BYTES

DEFAULT_QUEUE_SIZE

DEFAULT_POOL_SIZE

DEFAULT_PROCESSOR_WORKERS

DEFAULT_SENDER_WORKERS

DEFAULT_DOGSTATSD_PORT

SOCKET_TIMEOUT_MS

SOCKET_BUFFER_BYTES

DEFAULT_BLOCKING

DEFAULT_ENABLE_TELEMETRY

DEFAULT_ENABLE_AGGREGATION

CLIENT_TAG

CLIENT_VERSION_TAG

CLIENT_TRANSPORT_TAG

UTF_8

NUMBER_FORMATTER

SAMPLE_RATE_FORMATTER

statsDProcessor

telemetryStatsDProcessor

statsDSender

telemetryStatsDSender

telemetry

Constructor Detail

NonBlockingStatsDClient

Method Detail

format

createProcessor

createSender

stop

close

count

count

count

count

incrementCounter

incrementCounter

increment

increment

decrementCounter

decrementCounter

decrement

decrement

recordGaugeValue

recordGaugeValue

recordGaugeValue

recordGaugeValue

gauge

gauge

gauge

gauge

recordExecutionTime

recordExecutionTime

time

time

recordHistogramValue

recordHistogramValue

recordHistogramValue

recordHistogramValue

histogram

histogram

histogram

histogram

recordDistributionValue

recordDistributionValue

recordDistributionValue

recordDistributionValue

distribution

distribution

distribution