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, and gauges.

See the spec : https://github.com/b/statsd_spec

Author:

Milos Gregor

Method Summary

Modifier and Type	Method and Description
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, long value, Tag... tags) Records the latest fixed value for the specified named gauge.
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

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

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