com.timgroup.statsd

Class ConvenienceMethodProvidingStatsDClient

java.lang.Object

com.timgroup.statsd.ConvenienceMethodProvidingStatsDClient

All Implemented Interfaces:

StatsDClient

Direct Known Subclasses:

NonBlockingStatsDClient, NoOpStatsDClient

public abstract class ConvenienceMethodProvidingStatsDClient
extends java.lang.Object
implements StatsDClient

Constructor Summary

Constructors

Constructor and Description
ConvenienceMethodProvidingStatsDClient()

Method Summary

Methods

Modifier and Type	Method and Description
void	count(java.lang.String aspect, long delta) Adjusts the specified counter by a given delta.
void	decrement(java.lang.String aspect) Convenience method equivalent to decrementCounter(String).
void	decrementCounter(java.lang.String aspect) Convenience method equivalent to count(String, long) with a value of -1.
void	gauge(java.lang.String aspect, long value) Convenience method equivalent to StatsDClient.recordGaugeValue(String, long).
void	increment(java.lang.String aspect) Convenience method equivalent to incrementCounter(String).
void	incrementCounter(java.lang.String aspect) Convenience method equivalent to count(String, long) with a value of 1.
void	recordExecutionTime(java.lang.String aspect, long timeInMs) Records an execution time in milliseconds for the specified named operation.
void	recordExecutionTimeToNow(java.lang.String aspect, long systemTimeMillisAtStart) Records an execution time in milliseconds for the specified named operation.
void	set(java.lang.String aspect, java.lang.String eventName) Convenience method equivalent to StatsDClient.recordSetEvent(String, String).
void	time(java.lang.String aspect, long timeInMs) Convenience method equivalent to recordExecutionTime(String, long).

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.timgroup.statsd.StatsDClient

count, recordExecutionTime, recordGaugeDelta, recordGaugeValue, recordSetEvent, stop

Constructor Detail

ConvenienceMethodProvidingStatsDClient

public ConvenienceMethodProvidingStatsDClient()

Method Detail

count

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

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.

Specified by:

count in interface StatsDClient

Parameters:

aspect - the name of the counter to adjust

delta - the amount to adjust the counter by

incrementCounter

public final void incrementCounter(java.lang.String aspect)

Convenience method equivalent to count(String, long) with a value of 1.

Specified by:

incrementCounter in interface StatsDClient

Parameters:

aspect - the name of the counter to increment

increment

public final void increment(java.lang.String aspect)

Convenience method equivalent to incrementCounter(String).

Specified by:

increment in interface StatsDClient

decrementCounter

public final void decrementCounter(java.lang.String aspect)

Convenience method equivalent to count(String, long) with a value of -1.

Specified by:

decrementCounter in interface StatsDClient

Parameters:

aspect - the name of the counter to decrement

decrement

public final void decrement(java.lang.String aspect)

Convenience method equivalent to decrementCounter(String).

Specified by:

decrement in interface StatsDClient

gauge

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

Convenience method equivalent to StatsDClient.recordGaugeValue(String, long).

Specified by:

gauge in interface StatsDClient

set

public final void set(java.lang.String aspect,
       java.lang.String eventName)

Convenience method equivalent to StatsDClient.recordSetEvent(String, String).

Specified by:

set in interface StatsDClient

time

public final void time(java.lang.String aspect,
        long timeInMs)

Convenience method equivalent to recordExecutionTime(String, long).

Specified by:

time in interface StatsDClient

recordExecutionTime

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

Description copied from interface: StatsDClient

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

recordExecutionTimeToNow

public void recordExecutionTimeToNow(java.lang.String aspect,
                            long systemTimeMillisAtStart)

Description copied from interface: StatsDClient

Records an execution time in milliseconds for the specified named operation. The execution time is calculated as the delta between the specified start time and the current system time (using System.currentTimeMillis())

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

Specified by:

recordExecutionTimeToNow in interface StatsDClient

Parameters:

aspect - the name of the timed operation