Package com.itrsgroup.collection.instr.statsd

Class StatsdClientImpl

java.lang.Object

com.itrsgroup.collection.instr.AbstractMetricsClient

com.itrsgroup.collection.instr.statsd.StatsdClientImpl

All Implemented Interfaces:

MetricsClient, AutoCloseable

public class StatsdClientImpl
extends AbstractMetricsClient

Statsd MetricsClient with the following characteristics:

• All instrumentation methods never block or throw, ensuring that callers are not disrupted by metrics delivery.
• All post-construction exceptions are delivered via an optionally provided callback. If no callback is specified, exceptions are silently ignored.
• Instrumentation requests are queued and delivered by a dedicated thread. If the queue is full when a new request is submitted, the request will be dropped. An IOException will be raised via the callback the first time this occurs; future occurrences are silently ignored.

  This situation likely indicates a network problem or that the application is sending metrics faster than they can be processed. In the latter case, the queue can be increased to accommodate the load.

• The client is configured with a maximum message size. Any message that exceeds this size will be dropped and an IllegalArgumentException will be raised via the callback.
• Metric names and dimension keys/values are encoded using UTF-8.
• Safe for concurrent use by multiple threads.

Nested Class Summary

Nested classes/interfaces inherited from class com.itrsgroup.collection.instr.AbstractMetricsClient

AbstractMetricsClient.Sampler

Field Summary

Fields inherited from class com.itrsgroup.collection.instr.AbstractMetricsClient

NO_DIMENSIONS

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	StatsdClientImpl(StatsdSender sender, Set<Dimension> defaultDimensions, long samplingInterval, int maxMessageSize, Consumer<Throwable> errorCallback)	Constructor.

Method Summary

Modifier and Type	Method	Description
protected void	doAttribute(String namespace, String name, String value, Set<Dimension> dimensions)
protected void	doAttribute(String name, String value, Set<Dimension> dimensions)
protected void	doClose()	Close hook for implementations.
protected void	doCount(String metric, long delta, double sampleRate, Set<Dimension> dimensions)
protected void	doCount(String ns, String metric, long delta, double sampleRate, Set<Dimension> dimensions)
protected void	doEvent(String name, String message, Severity severity, Set<Dimension> dimensions)
protected void	doEvent(String namespace, String name, String message, Severity severity, Set<Dimension> dimensions)
protected void	doGauge(String metric, double value, boolean isDelta, Unit unit, Set<Dimension> dimensions)
protected void	doGauge(String namespace, String metric, double value, boolean isDelta, Unit unit, Set<Dimension> dimensions)
protected void	doTimer(String name, long value, TimeUnit unit, double sampleRate, Set<Dimension> dimensions)
protected void	doTimer(String namespace, String name, long value, TimeUnit unit, double sampleRate, Set<Dimension> dimensions)
protected void	doUnique(String namespace, String metric, String identifier, Set<Dimension> dimensions)
protected void	doUnique(String metric, String identifier, Set<Dimension> dimensions)
Set<Dimension>	getDefaultDimensions()
int	getMaxMessageSize()

Methods inherited from class com.itrsgroup.collection.instr.AbstractMetricsClient

adjustGauge, adjustGauge, adjustGauge, adjustGauge, adjustGauge, adjustGauge, adjustGauge, adjustGauge, attribute, attribute, attribute, attribute, clearGaugeSamplers, close, count, count, count, count, count, count, count, count, decrement, decrement, decrement, decrement, decrement, decrement, decrement, decrement, event, event, event, event, fractionalMillis, gauge, gauge, gauge, gauge, gauge, gauge, gauge, gauge, gauge, gauge, gauge, gauge, gauge, gauge, gauge, gauge, getSamplingInterval, increment, increment, increment, increment, increment, increment, increment, increment, isClosing, removeGaugeSampler, removeGaugeSampler, removeGaugeSampler, removeGaugeSampler, requireNotEmpty, requireNotNull, scheduleTask, shouldSample, submitTask, timer, timer, timer, timer, timer, timer, timer, timer, timer, timer, timer, timer, timer, timer, timer, timer, unique, unique, unique, unique

Methods inherited from class java.lang.Object

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

Constructor Details

StatsdClientImpl

protected StatsdClientImpl(StatsdSender sender,
 Set<Dimension> defaultDimensions,
 long samplingInterval,
 int maxMessageSize,
 Consumer<Throwable> errorCallback)

Constructor.

This constructor should not be used directly - use StatsdClientBuilder to create a client.

Parameters:

sender - sender

defaultDimensions - dimensions to add to all metrics

samplingInterval - interval (in millis) for periodic metric sampling

maxMessageSize - maximum message size (messages exceeding this are dropped)

errorCallback - callback for receiving exceptions

Method Details

doAttribute

protected void doAttribute(String name,
 String value,
 Set<Dimension> dimensions)

Specified by:

doAttribute in class AbstractMetricsClient

doAttribute

protected void doAttribute(String namespace,
 String name,
 String value,
 Set<Dimension> dimensions)

Overrides:

doAttribute in class AbstractMetricsClient

doCount

protected void doCount(String metric,
 long delta,
 double sampleRate,
 Set<Dimension> dimensions)

Specified by:

doCount in class AbstractMetricsClient

doCount

protected void doCount(String ns,
 String metric,
 long delta,
 double sampleRate,
 Set<Dimension> dimensions)

Overrides:

doCount in class AbstractMetricsClient

doEvent

protected void doEvent(String name,
 String message,
 Severity severity,
 Set<Dimension> dimensions)

Specified by:

doEvent in class AbstractMetricsClient

doEvent

protected void doEvent(String namespace,
 String name,
 String message,
 Severity severity,
 Set<Dimension> dimensions)

Overrides:

doEvent in class AbstractMetricsClient

doGauge

protected void doGauge(String metric,
 double value,
 boolean isDelta,
 Unit unit,
 Set<Dimension> dimensions)

Specified by:

doGauge in class AbstractMetricsClient

doGauge

protected void doGauge(String namespace,
 String metric,
 double value,
 boolean isDelta,
 Unit unit,
 Set<Dimension> dimensions)

Overrides:

doGauge in class AbstractMetricsClient

doTimer

protected void doTimer(String name,
 long value,
 TimeUnit unit,
 double sampleRate,
 Set<Dimension> dimensions)

Specified by:

doTimer in class AbstractMetricsClient

doTimer

protected void doTimer(String namespace,
 String name,
 long value,
 TimeUnit unit,
 double sampleRate,
 Set<Dimension> dimensions)

Overrides:

doTimer in class AbstractMetricsClient

doUnique

protected void doUnique(String metric,
 String identifier,
 Set<Dimension> dimensions)

Specified by:

doUnique in class AbstractMetricsClient

doUnique

protected void doUnique(String namespace,
 String metric,
 String identifier,
 Set<Dimension> dimensions)

Overrides:

doUnique in class AbstractMetricsClient

doClose

protected void doClose()

Description copied from class: AbstractMetricsClient

Close hook for implementations.

Overrides:

doClose in class AbstractMetricsClient

getMaxMessageSize

public int getMaxMessageSize()

Returns:

max configured message size in bytes

getDefaultDimensions

public Set<Dimension> getDefaultDimensions()

Returns:

default dimensions added to each message