StatsDClient (java-dogstatsd-client 2.8.1 API)

All Superinterfaces:

AutoCloseable, Closeable

All Known Implementing Classes:

NonBlockingStatsDClient, NoOpStatsDClient
```
public interface StatsDClient
extends Closeable
```
Describes a client connection to a StatsD server, which may be used to post metrics in the form of counters, timers, and gauges.
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
Author:

Tom Denley

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`void`	`close()`
`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.
`void`	`decrement(String aspect, double sampleRate, String... tags)` Convenience method equivalent to `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 `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 `recordDistributionValue(String, long, double, String[])`.
`void`	`distribution(String aspect, long value, String... tags)` Convenience method equivalent to `recordDistributionValue(String, long, String[])`.
`void`	`gauge(String aspect, double value, double sampleRate, String... tags)` Convenience method equivalent to `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 `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 `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 `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 `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.
`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... tags)` 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 value, 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 `recordExecutionTime(String, long, double, String[])`.
`void`	`time(String aspect, long value, String... tags)` Convenience method equivalent to `recordExecutionTime(String, long, String[])`.

- Method Detail
  - stop
```
void stop()
```
    Cleanly shut down this StatsD client. This method may throw an exception if the socket cannot be closed.
  - close
```
void close()
```
    Specified by:
    
    close in interface AutoCloseable
    
    Specified by:
    
    close in interface Closeable
    
    See Also:
    
    stop()
  - count
```
void count(String aspect,
           long delta,
           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.
    
    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
```
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.
    
    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
```
void count(String aspect,
           double delta,
           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.
    
    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
```
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.
    
    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
```
void incrementCounter(String aspect,
                      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.
    
    Parameters:
    
    aspect - the name of the counter to increment
    
    tags - array of tags to be added to the data
  - incrementCounter
```
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.
    
    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
```
void increment(String aspect,
               String... tags)
```
    Convenience method equivalent to incrementCounter(String, String[]).
  - increment
```
void increment(String aspect,
               double sampleRate,
               String... tags)
```
    Convenience method equivalent to incrementCounter(String, double, String[]).
  - decrementCounter
```
void decrementCounter(String aspect,
                      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.
    
    Parameters:
    
    aspect - the name of the counter to decrement
    
    tags - array of tags to be added to the data
  - decrementCounter
```
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.
    
    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
```
void decrement(String aspect,
               String... tags)
```
    Convenience method equivalent to decrementCounter(String, String[]).
  - decrement
```
void decrement(String aspect,
               double sampleRate,
               String... tags)
```
    Convenience method equivalent to decrementCounter(String, double, String[]).
  - recordGaugeValue
```
void recordGaugeValue(String aspect,
                      double value,
                      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.
    
    Parameters:
    
    aspect - the name of the gauge
    
    value - the new reading of the gauge
  - recordGaugeValue
```
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.
    
    Parameters:
    
    aspect - the name of the gauge
    
    sampleRate - percentage of time metric to be sent
    
    value - the new reading of the gauge
  - gauge
```
void gauge(String aspect,
           double value,
           String... tags)
```
    Convenience method equivalent to recordGaugeValue(String, double, String[]).
  - gauge
```
void gauge(String aspect,
           double value,
           double sampleRate,
           String... tags)
```
    Convenience method equivalent to recordGaugeValue(String, double, double, String[]).
  - recordGaugeValue
```
void recordGaugeValue(String aspect,
                      long value,
                      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.
    
    Parameters:
    
    aspect - the name of the gauge
    
    value - the new reading of the gauge
  - recordGaugeValue
```
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.
    
    Parameters:
    
    aspect - the name of the gauge
    
    sampleRate - percentage of time metric to be sent
    
    value - the new reading of the gauge
  - gauge
```
void gauge(String aspect,
           long value,
           String... tags)
```
    Convenience method equivalent to recordGaugeValue(String, long, String[]).
  - gauge
```
void gauge(String aspect,
           long value,
           double sampleRate,
           String... tags)
```
    Convenience method equivalent to recordGaugeValue(String, long, double, String[]).
  - recordExecutionTime
```
void recordExecutionTime(String aspect,
                         long timeInMs,
                         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.
    
    Parameters:
    
    aspect - the name of the timed operation
    
    timeInMs - the time in milliseconds
    
    tags - array of tags to be added to the data
  - recordExecutionTime
```
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.
    
    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
```
void time(String aspect,
          long value,
          String... tags)
```
    Convenience method equivalent to recordExecutionTime(String, long, String[]).
  - time
```
void time(String aspect,
          long value,
          double sampleRate,
          String... tags)
```
    Convenience method equivalent to recordExecutionTime(String, long, double, String[]).
  - recordHistogramValue
```
void recordHistogramValue(String aspect,
                          double value,
                          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.
    
    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
```
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.
    
    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
```
void histogram(String aspect,
               double value,
               String... tags)
```
    Convenience method equivalent to recordHistogramValue(String, double, String[]).
  - histogram
```
void histogram(String aspect,
               double value,
               double sampleRate,
               String... tags)
```
    Convenience method equivalent to recordHistogramValue(String, double, double, String[]).
  - recordHistogramValue
```
void recordHistogramValue(String aspect,
                          long value,
                          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.
    
    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
```
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.
    
    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
```
void histogram(String aspect,
               long value,
               String... tags)
```
    Convenience method equivalent to recordHistogramValue(String, long, String[]).
  - histogram
```
void histogram(String aspect,
               long value,
               double sampleRate,
               String... tags)
```
    Convenience method equivalent to recordHistogramValue(String, long, double, String[]).
  - recordDistributionValue
```
void recordDistributionValue(String aspect,
                             double value,
                             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.
    
    This is a beta feature and must be enabled specifically for your organization.
    
    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
```
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.
    
    This is a beta feature and must be enabled specifically for your organization.
    
    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
```
void distribution(String aspect,
                  double value,
                  String... tags)
```
    Convenience method equivalent to recordDistributionValue(String, double, String[]).
  - distribution
```
void distribution(String aspect,
                  double value,
                  double sampleRate,
                  String... tags)
```
    Convenience method equivalent to recordDistributionValue(String, double, double, String[]).
  - recordDistributionValue
```
void recordDistributionValue(String aspect,
                             long value,
                             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.
    
    This is a beta feature and must be enabled specifically for your organization.
    
    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
```
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.
    
    This is a beta feature and must be enabled specifically for your organization.
    
    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
```
void distribution(String aspect,
                  long value,
                  String... tags)
```
    Convenience method equivalent to recordDistributionValue(String, long, String[]).
  - distribution
```
void distribution(String aspect,
                  long value,
                  double sampleRate,
                  String... tags)
```
    Convenience method equivalent to recordDistributionValue(String, long, double, String[]).
  - recordEvent
```
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.
    
    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
```
void recordServiceCheckRun(ServiceCheck sc)
```
    Records a run status for the specified named service check.
    
    Parameters:
    
    sc - the service check object
  - serviceCheck
```
void serviceCheck(ServiceCheck sc)
```
    Convenience method equivalent to recordServiceCheckRun(ServiceCheck sc).
  - recordSetValue
```
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.
    
    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

Interface StatsDClient

Method Summary

Method Detail

stop

close

count

count

count

count

incrementCounter

incrementCounter

increment

increment

decrementCounter

decrementCounter

decrement

decrement

recordGaugeValue

recordGaugeValue

gauge

gauge

recordGaugeValue

recordGaugeValue

gauge

gauge

recordExecutionTime

recordExecutionTime

time

time

recordHistogramValue

recordHistogramValue

histogram

histogram

recordHistogramValue

recordHistogramValue

histogram

histogram

recordDistributionValue

recordDistributionValue

distribution

distribution

recordDistributionValue

recordDistributionValue

distribution

distribution

recordEvent

recordServiceCheckRun

serviceCheck

recordSetValue