com.timgroup.statsd

Class NoOpStatsDClient

java.lang.Object

com.timgroup.statsd.ConvenienceMethodProvidingStatsDClient

com.timgroup.statsd.NoOpStatsDClient

All Implemented Interfaces:

StatsDClient

public final class NoOpStatsDClient
extends ConvenienceMethodProvidingStatsDClient

A No-Op StatsDClient, which can be substituted in when metrics are not required.

Author:

Tom Denley

Constructor Summary

Constructors

Constructor and Description
NoOpStatsDClient()

Method Summary

Methods

Modifier and Type	Method and Description
void	count(java.lang.String aspect, long delta, double sampleRate) Adjusts the specified counter by a given delta.
void	recordExecutionTime(java.lang.String aspect, long timeInMs, double sampleRate) Adjusts the specified counter by a given delta.
void	recordGaugeDelta(java.lang.String aspect, long delta) Records a change in the value of the specified named gauge.
void	recordGaugeValue(java.lang.String aspect, long value) Records the latest fixed value for the specified named gauge.
void	recordSetEvent(java.lang.String aspect, java.lang.String value) StatsD supports counting unique occurrences of events between flushes, Call this method to records an occurrence of the specified named event.
void	stop() Cleanly shut down this StatsD client.

Methods inherited from class com.timgroup.statsd.ConvenienceMethodProvidingStatsDClient

count, decrement, decrementCounter, gauge, increment, incrementCounter, recordExecutionTime, recordExecutionTimeToNow, set, time

Methods inherited from class java.lang.Object

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

Constructor Detail

NoOpStatsDClient

public NoOpStatsDClient()

Method Detail

stop

public void stop()

Description copied from interface: StatsDClient

Cleanly shut down this StatsD client. This method may throw an exception if the socket cannot be closed.

count

public void count(java.lang.String aspect,
         long delta,
         double sampleRate)

Description copied from interface: StatsDClient

Adjusts the specified counter by a given delta.

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 - the sampling rate being employed. For example, a rate of 0.1 would tell StatsD that this counter is being sent sampled every 1/10th of the time.

recordGaugeValue

public void recordGaugeValue(java.lang.String aspect,
                    long value)

Description copied from interface: StatsDClient

Records the latest fixed value for the specified named gauge.

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

recordGaugeDelta

public void recordGaugeDelta(java.lang.String aspect,
                    long delta)

Description copied from interface: StatsDClient

Records a change in the value of the specified named gauge.

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

Parameters:

aspect - the name of the gauge

delta - the +/- delta to apply to the gauge

recordSetEvent

public void recordSetEvent(java.lang.String aspect,
                  java.lang.String value)

Description copied from interface: StatsDClient

StatsD supports counting unique occurrences of events between flushes, Call this method to records an occurrence of the specified named event.

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

Parameters:

aspect - the name of the set

value - the value to be added to the set

recordExecutionTime

public void recordExecutionTime(java.lang.String aspect,
                       long timeInMs,
                       double sampleRate)

Description copied from interface: StatsDClient

Adjusts the specified counter by a given delta.

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

Parameters:

aspect - the name of the counter to adjust

sampleRate - the sampling rate being employed. For example, a rate of 0.1 would tell StatsD that this timer is being sent sampled every 1/10th of the time, so that it updates its timer_counters appropriately.