tech.energyit.statsd

Interface StatsDClient

All Known Implementing Classes:

FastStatsDClient

public interface StatsDClient

Describes a client connection to a StatsD server, which may be used to post metrics in the form of counters, timers, gauges, histograms or sets..

See the spec : https://github.com/statsd/statsd/blob/master/docs/metric_types.md

Author:

Milos Gregor

Method Summary

Modifier and Type	Method and Description
void	count(byte[] aspect, double delta, double sampleRate, Tag... tags) Adjusts the specified counter by a given delta.
void	count(byte[] aspect, double delta, Tag... tags) Adjusts the specified counter by a given delta.
void	count(byte[] aspect, long delta, double sampleRate, Tag... tags) Adjusts the specified counter by a given delta.
void	count(byte[] aspect, long delta, Tag... tags) Adjusts the specified counter by a given delta.
void	gauge(byte[] aspect, char deltaSign, double value, Tag... tags) Records the delta value for the specified named gauge.
void	gauge(byte[] aspect, char deltaSign, long value, Tag... tags) Records the delta value for the specified named gauge.
void	gauge(byte[] aspect, double value, double sampleRate, Tag... tags) Records the latest fixed value for the specified named gauge.
void	gauge(byte[] aspect, double value, Tag... tags) Records the latest fixed value for the specified named gauge.
void	gauge(byte[] aspect, long value, double sampleRate, Tag... tags) Records the latest fixed value for the specified named gauge.
void	gauge(byte[] aspect, long value, Tag... tags) Records the latest fixed value for the specified named gauge.
void	histogram(byte[] aspect, double value, double sampleRate, Tag... tags) Records a value for the specified named histogram.
void	histogram(byte[] aspect, double value, Tag... tags) Records a value for the specified named histogram.
void	histogram(byte[] aspect, long value, double sampleRate, Tag... tags) Records a value for the specified named histogram.
void	histogram(byte[] aspect, long value, Tag... tags) Records a value for the specified named histogram.
void	meter(byte[] aspect, double value, Tag... tags) Records a value for the specified named meter.
void	meter(byte[] aspect, long value, Tag... tags) Records a value for the specified named meter.
void	set(byte[] aspect, double value, double sampleRate, Tag... tags) Records a value for the specified named set.
void	set(byte[] aspect, double value, Tag... tags) Records a value for the specified named set.
void	set(byte[] aspect, long value, double sampleRate, Tag... tags) Records a value for the specified named set.
void	set(byte[] aspect, long value, Tag... tags) Records a value for the specified named distribution.
void	time(byte[] aspect, long timeInMs, double sampleRate, Tag... tags) Records an execution time in milliseconds for the specified named operation.
void	time(byte[] aspect, long timeInMs, Tag... tags) Records an execution time in milliseconds for the specified named operation.

Method Detail

gauge

void gauge(byte[] aspect,
           long value,
           Tag... tags)

Records the latest fixed value for the specified named gauge.

Parameters:

aspect - the name of the gauge

value - the new reading of the gauge

gauge

void gauge(byte[] aspect,
           char deltaSign,
           long value,
           Tag... tags)

Records the delta value for the specified named gauge.

Parameters:

aspect - the name of the gauge

deltaSign - either '+' or '-' to indicate either increase or decrease gauge value

value - the (positive!) change of value

gauge

void gauge(byte[] aspect,
           long value,
           double sampleRate,
           Tag... tags)

Records the latest fixed value for the specified named gauge.

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

void gauge(byte[] aspect,
           double value,
           Tag... tags)

Records the latest fixed value for the specified named gauge.

Parameters:

aspect - the name of the gauge

value - the new reading of the gauge

gauge

void gauge(byte[] aspect,
           char deltaSign,
           double value,
           Tag... tags)

Records the delta value for the specified named gauge.

Parameters:

aspect - the name of the gauge

deltaSign - either '+' or '-' to indicate either increase or decrease gauge value

value - the (positive!) change of value

gauge

void gauge(byte[] aspect,
           double value,
           double sampleRate,
           Tag... tags)

Records the latest fixed value for the specified named gauge.

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

count

void count(byte[] aspect,
           long delta,
           Tag... tags)

Adjusts the specified counter by a given delta.

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(byte[] aspect,
           long delta,
           double sampleRate,
           Tag... tags)

Adjusts the specified counter by a given delta.

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(byte[] aspect,
           double delta,
           Tag... tags)

Adjusts the specified counter by a given delta.

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(byte[] aspect,
           double delta,
           double sampleRate,
           Tag... tags)

Adjusts the specified counter by a given delta.

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

time

void time(byte[] aspect,
          long timeInMs,
          Tag... tags)

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

Parameters:

aspect - the name of the timed operation

timeInMs - the time in milliseconds

tags - array of tags to be added to the data

time

void time(byte[] aspect,
          long timeInMs,
          double sampleRate,
          Tag... tags)

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

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

histogram

void histogram(byte[] aspect,
               long value,
               Tag... tags)

Records a value for the specified named histogram.

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

void histogram(byte[] aspect,
               long value,
               double sampleRate,
               Tag... tags)

Records a value for the specified named histogram.

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(byte[] aspect,
               double value,
               Tag... tags)

Records a value for the specified named histogram.

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

void histogram(byte[] aspect,
               double value,
               double sampleRate,
               Tag... tags)

Records a value for the specified named histogram.

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

set

void set(byte[] aspect,
         long value,
         Tag... tags)

Records a value for the specified named distribution.

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

set

void set(byte[] aspect,
         long value,
         double sampleRate,
         Tag... tags)

Records a value for the specified named set.

Parameters:

aspect - the name of the set

value - the value to be incorporated in the set

sampleRate - percentage of time metric to be sent

tags - array of tags to be added to the data

set

void set(byte[] aspect,
         double value,
         Tag... tags)

Records a value for the specified named set.

Parameters:

aspect - the name of the set

value - the value to be incorporated in the set

tags - array of tags to be added to the data

set

void set(byte[] aspect,
         double value,
         double sampleRate,
         Tag... tags)

Records a value for the specified named set.

Parameters:

aspect - the name of the set

value - the value to be incorporated in the set

sampleRate - percentage of time metric to be sent

tags - array of tags to be added to the data

meter

void meter(byte[] aspect,
           long value,
           Tag... tags)

Records a value for the specified named meter.

Parameters:

aspect - the name of the meter

value - the value to be incorporated in the meter

tags - array of tags to be added to the data

meter

void meter(byte[] aspect,
           double value,
           Tag... tags)

Records a value for the specified named meter.

Parameters:

aspect - the name of the meter

value - the value to be incorporated in the meter

tags - array of tags to be added to the data