com.blacklocus.metrics

Class CloudWatchReporter

java.lang.Object

com.codahale.metrics.ScheduledReporter

com.blacklocus.metrics.CloudWatchReporter

All Implemented Interfaces:

com.codahale.metrics.Reporter, java.io.Closeable, java.lang.AutoCloseable

public class CloudWatchReporter
extends com.codahale.metrics.ScheduledReporter

Included dimension

One dimension is always included with the dimension name defined in Constants.DEF_DIM_NAME_TYPE. This corresponds to a type of metric submissions to CloudWatch.

Refer to [README.md](https://github.com/blacklocus/metrics-cloudwatch/blob/master/README.md) for documentation on metric submission types.

Custom dimensions

CloudWatch does not aggregate over dimensionChain on custom metrics, see http://docs.aws.amazon.com/AmazonCloudWatch/latest/DeveloperGuide/cloudwatch_concepts.html#Dimension To achieve similar convenience, we can submit metrics in duplicate, once for each tuple of attributes against which we would aggregate metrics.

Refer to [README.md](https://github.com/blacklocus/metrics-cloudwatch/blob/master/README.md) for documentation on the name-encoded syntax of dimensions and permutable components.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEF_DIM_VAL_COUNTER_COUNT Deprecated. maintained for backwards compatibility. Will eventually be replaced by Constants.DEF_DIM_VAL_COUNTER_COUNT. The default value will change from "counterSum" to
static java.lang.String	DEF_DIM_VAL_HISTO_SAMPLES Deprecated. maintained for backwards compatibility. Will eventually be replaced by Constants.DEF_DIM_VAL_HISTO_SAMPLES. The default value will change from "histogramCount" to
static java.lang.String	DEF_DIM_VAL_HISTO_STATS Deprecated. maintained for backwards compatibility. Will eventually be replaced by Constants.DEF_DIM_VAL_HISTO_STATS. The default value will change from "histogramSet" to
static java.lang.String	DEF_DIM_VAL_METER_COUNT Deprecated. maintained for backwards compatibility. Will eventually be replaced by Constants.DEF_DIM_VAL_METER_COUNT. The default value will change from "meterSum" to
static java.lang.String	DEF_DIM_VAL_TIMER_SAMPLES Deprecated. maintained for backwards compatibility. Will eventually be replaced by Constants.DEF_DIM_VAL_TIMER_SAMPLES. The default value will change from "timerCount" to
static java.lang.String	DEF_DIM_VAL_TIMER_STATS Deprecated. maintained for backwards compatibility. Will eventually be replaced by Constants.DEF_DIM_VAL_TIMER_STATS. The default value will change from "timerSet" to
static java.lang.String	METRIC_TYPE_DIMENSION Deprecated. maintained for backwards compatibility. Will eventually be replaced by Constants.DEF_DIM_NAME_TYPE. The default value will change from "type" to
static java.lang.String	NAME_DIMENSION_SEPARATOR Deprecated. maintained for backwards compatibility. Moved to Constants.NAME_DIMENSION_SEPARATOR
static java.lang.String	NAME_PERMUTE_MARKER Deprecated. maintained for backwards compatibility. Moved to Constants.NAME_PERMUTE_MARKER
static java.lang.String	NAME_TOKEN_DELIMITER Deprecated. maintained for backwards compatibility. Moved to Constants.NAME_TOKEN_DELIMITER
static java.lang.String	NAME_TOKEN_DELIMITER_RGX Deprecated. maintained for backwards compatibility. Moved to Constants.NAME_TOKEN_DELIMITER_RGX
static java.lang.String	VALID_DIMENSION_PART_RGX Deprecated. maintained for backwards compatibility. Moved to Constants.VALID_DIMENSION_PART_RGX
static java.lang.String	VALID_NAME_TOKEN_RGX Deprecated. maintained for backwards compatibility. Moved to Constants.VALID_NAME_TOKEN_RGX

Constructor Summary

Constructors

Constructor and Description
CloudWatchReporter(com.codahale.metrics.MetricRegistry registry, com.amazonaws.services.cloudwatch.AmazonCloudWatchAsync cloudWatch) Creates a new ScheduledReporter instance.
CloudWatchReporter(com.codahale.metrics.MetricRegistry registry, java.lang.String metricNamespace, com.amazonaws.services.cloudwatch.AmazonCloudWatchAsync cloudWatch) Creates a new ScheduledReporter instance.
CloudWatchReporter(com.codahale.metrics.MetricRegistry registry, java.lang.String metricNamespace, com.codahale.metrics.MetricFilter metricFilter, com.amazonaws.services.cloudwatch.AmazonCloudWatchAsync cloudWatch) Creates a new ScheduledReporter instance.

Method Summary

Modifier and Type	Method and Description
void	report(java.util.SortedMap<java.lang.String,com.codahale.metrics.Gauge> gauges, java.util.SortedMap<java.lang.String,com.codahale.metrics.Counter> counters, java.util.SortedMap<java.lang.String,com.codahale.metrics.Histogram> histograms, java.util.SortedMap<java.lang.String,com.codahale.metrics.Meter> meters, java.util.SortedMap<java.lang.String,com.codahale.metrics.Timer> timers)
CloudWatchReporter	withDimensions(java.lang.String dimensions) Sets global reporter-wide dimensions and returns itself.
CloudWatchReporter	withReporterFilter(com.google.common.base.Predicate<com.amazonaws.services.cloudwatch.model.MetricDatum> reporterFilter) This filter is applied right before submission to CloudWatch.
CloudWatchReporter	withTimestampLocal(boolean timestampLocal)
CloudWatchReporter	withTypeDimName(java.lang.String typeDimName)
CloudWatchReporter	withTypeDimValCounterCount(java.lang.String typeDimValCounterCount)
CloudWatchReporter	withTypeDimValGauge(java.lang.String typeDimValGauge)
CloudWatchReporter	withTypeDimValHistoSamples(java.lang.String typeDimValHistoSamples)
CloudWatchReporter	withTypeDimValHistoStats(java.lang.String typeDimValHistoStats)
CloudWatchReporter	withTypeDimValMeterCount(java.lang.String typeDimValMeterCount)
CloudWatchReporter	withTypeDimValTimerSamples(java.lang.String typeDimValTimerSamples)
CloudWatchReporter	withTypeDimValTimerStats(java.lang.String typeDimValTimerStats)

Methods inherited from class com.codahale.metrics.ScheduledReporter

close, convertDuration, convertRate, getDurationUnit, getRateUnit, report, start, stop

Methods inherited from class java.lang.Object

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

Field Detail

NAME_TOKEN_DELIMITER_RGX

@Deprecated
public static final java.lang.String NAME_TOKEN_DELIMITER_RGX

Deprecated. maintained for backwards compatibility. Moved to Constants.NAME_TOKEN_DELIMITER_RGX

See Also:

Constant Field Values

NAME_TOKEN_DELIMITER

@Deprecated
public static final java.lang.String NAME_TOKEN_DELIMITER

Deprecated. maintained for backwards compatibility. Moved to Constants.NAME_TOKEN_DELIMITER

See Also:

Constant Field Values

NAME_DIMENSION_SEPARATOR

@Deprecated
public static final java.lang.String NAME_DIMENSION_SEPARATOR

Deprecated. maintained for backwards compatibility. Moved to Constants.NAME_DIMENSION_SEPARATOR

See Also:

Constant Field Values

NAME_PERMUTE_MARKER

@Deprecated
public static final java.lang.String NAME_PERMUTE_MARKER

Deprecated. maintained for backwards compatibility. Moved to Constants.NAME_PERMUTE_MARKER

See Also:

Constant Field Values

VALID_NAME_TOKEN_RGX

@Deprecated
public static final java.lang.String VALID_NAME_TOKEN_RGX

Deprecated. maintained for backwards compatibility. Moved to Constants.VALID_NAME_TOKEN_RGX

See Also:

Constant Field Values

VALID_DIMENSION_PART_RGX

@Deprecated
public static final java.lang.String VALID_DIMENSION_PART_RGX

Deprecated. maintained for backwards compatibility. Moved to Constants.VALID_DIMENSION_PART_RGX

See Also:

Constant Field Values

METRIC_TYPE_DIMENSION

@Deprecated
public static final java.lang.String METRIC_TYPE_DIMENSION

Deprecated. maintained for backwards compatibility. Will eventually be replaced by Constants.DEF_DIM_NAME_TYPE. The default value will change from "type" to

See Also:

Constant Field Values

DEF_DIM_VAL_COUNTER_COUNT

@Deprecated
public static final java.lang.String DEF_DIM_VAL_COUNTER_COUNT

Deprecated. maintained for backwards compatibility. Will eventually be replaced by Constants.DEF_DIM_VAL_COUNTER_COUNT. The default value will change from "counterSum" to

See Also:

Constant Field Values

DEF_DIM_VAL_METER_COUNT

@Deprecated
public static final java.lang.String DEF_DIM_VAL_METER_COUNT

Deprecated. maintained for backwards compatibility. Will eventually be replaced by Constants.DEF_DIM_VAL_METER_COUNT. The default value will change from "meterSum" to

See Also:

Constant Field Values

DEF_DIM_VAL_HISTO_SAMPLES

@Deprecated
public static final java.lang.String DEF_DIM_VAL_HISTO_SAMPLES

Deprecated. maintained for backwards compatibility. Will eventually be replaced by Constants.DEF_DIM_VAL_HISTO_SAMPLES. The default value will change from "histogramCount" to

See Also:

Constant Field Values

DEF_DIM_VAL_HISTO_STATS

@Deprecated
public static final java.lang.String DEF_DIM_VAL_HISTO_STATS

Deprecated. maintained for backwards compatibility. Will eventually be replaced by Constants.DEF_DIM_VAL_HISTO_STATS. The default value will change from "histogramSet" to

See Also:

Constant Field Values

DEF_DIM_VAL_TIMER_SAMPLES

@Deprecated
public static final java.lang.String DEF_DIM_VAL_TIMER_SAMPLES

Deprecated. maintained for backwards compatibility. Will eventually be replaced by Constants.DEF_DIM_VAL_TIMER_SAMPLES. The default value will change from "timerCount" to

See Also:

Constant Field Values

DEF_DIM_VAL_TIMER_STATS

@Deprecated
public static final java.lang.String DEF_DIM_VAL_TIMER_STATS

Deprecated. maintained for backwards compatibility. Will eventually be replaced by Constants.DEF_DIM_VAL_TIMER_STATS. The default value will change from "timerSet" to

See Also:

Constant Field Values

Constructor Detail

CloudWatchReporter

public CloudWatchReporter(com.codahale.metrics.MetricRegistry registry,
                          com.amazonaws.services.cloudwatch.AmazonCloudWatchAsync cloudWatch)

Creates a new ScheduledReporter instance. The reporter does not report metrics until ScheduledReporter.start(long, TimeUnit).

Parameters:

registry - the MetricRegistry containing the metrics this reporter will report

cloudWatch - client

CloudWatchReporter

public CloudWatchReporter(com.codahale.metrics.MetricRegistry registry,
                          java.lang.String metricNamespace,
                          com.amazonaws.services.cloudwatch.AmazonCloudWatchAsync cloudWatch)

Creates a new ScheduledReporter instance. The reporter does not report metrics until ScheduledReporter.start(long, TimeUnit).

Parameters:

registry - the MetricRegistry containing the metrics this reporter will report

metricNamespace - (optional) CloudWatch metric namespace that all metrics reported by this reporter will fall under

cloudWatch - client

CloudWatchReporter

public CloudWatchReporter(com.codahale.metrics.MetricRegistry registry,
                          java.lang.String metricNamespace,
                          com.codahale.metrics.MetricFilter metricFilter,
                          com.amazonaws.services.cloudwatch.AmazonCloudWatchAsync cloudWatch)

Creates a new ScheduledReporter instance. The reporter does not report metrics until ScheduledReporter.start(long, TimeUnit).

Parameters:

registry - the MetricRegistry containing the metrics this reporter will report

metricNamespace - (optional) CloudWatch metric namespace that all metrics reported by this reporter will fall under

metricFilter - (optional) see MetricFilter

cloudWatch - client

Method Detail

withDimensions

public CloudWatchReporter withDimensions(java.lang.String dimensions)

Sets global reporter-wide dimensions and returns itself.

Parameters:

dimensions - (optional) the string representing global dimensions

Returns:

this (for chaining)

withTimestampLocal

public CloudWatchReporter withTimestampLocal(boolean timestampLocal)

Parameters:

timestampLocal - Whether or not to explicitly timestamp metric data to now (true), or leave it null so that CloudWatch will timestamp it on receipt (false). Defaults to false.

Returns:

this (for chaining)

withTypeDimName

public CloudWatchReporter withTypeDimName(java.lang.String typeDimName)

Parameters:

typeDimName - name of the "metric type" dimension added to CloudWatch submissions. Defaults to "type" when using CloudWatchReporter constructors directly (backwards-compatibility) or when using the CloudWatchReporterBuilder

Returns:

this (for chaining)

withTypeDimValGauge

public CloudWatchReporter withTypeDimValGauge(java.lang.String typeDimValGauge)

Parameters:

typeDimValGauge - value of the "metric type" dimension added to CloudWatch submissions of Gauges. Defaults to when using either CloudWatchReporter constructors directly (backwards-compatibility) or when using the CloudWatchReporterBuilder

Returns:

this (for chaining)

withTypeDimValCounterCount

public CloudWatchReporter withTypeDimValCounterCount(java.lang.String typeDimValCounterCount)

Parameters:

typeDimValCounterCount - value of the "metric type" dimension added to CloudWatch submissions of Counter.getCount(). Defaults to "counterSum" when using CloudWatchReporter constructors directly (backwards-compatibility) or when using the CloudWatchReporterBuilder

Returns:

this (for chaining)

withTypeDimValMeterCount

public CloudWatchReporter withTypeDimValMeterCount(java.lang.String typeDimValMeterCount)

Parameters:

typeDimValMeterCount - value of the "metric type" dimension added to CloudWatch submissions of Meter.getCount(). Defaults to "meterSum" when using CloudWatchReporter constructors directly (backwards-compatibility) or when using the CloudWatchReporterBuilder

Returns:

this (for chaining)

withTypeDimValHistoSamples

public CloudWatchReporter withTypeDimValHistoSamples(java.lang.String typeDimValHistoSamples)

Parameters:

typeDimValHistoSamples - value of the "metric type" dimension added to CloudWatch submissions of Histogram.getCount(). Defaults to "histogramCount" when using CloudWatchReporter constructors directly (backwards-compatibility) or when using the CloudWatchReporterBuilder

Returns:

this (for chaining)

withTypeDimValHistoStats

public CloudWatchReporter withTypeDimValHistoStats(java.lang.String typeDimValHistoStats)

Parameters:

typeDimValHistoStats - value of the "metric type" dimension added to CloudWatch submissions of Histogram.getSnapshot(). Defaults to "histogramSet" when using CloudWatchReporter constructors directly (backwards-compatibility) or when using the CloudWatchReporterBuilder

Returns:

this (for chaining)

withTypeDimValTimerSamples

public CloudWatchReporter withTypeDimValTimerSamples(java.lang.String typeDimValTimerSamples)

Parameters:

typeDimValTimerSamples - value of the "metric type" dimension added to CloudWatch submissions of Timer.getCount(). Defaults to "timerCount" when using CloudWatchReporter constructors directly (backwards-compatibility) or when using the CloudWatchReporterBuilder

Returns:

this (for chaining)

withTypeDimValTimerStats

public CloudWatchReporter withTypeDimValTimerStats(java.lang.String typeDimValTimerStats)

Parameters:

typeDimValTimerStats - value of the "metric type" dimension added to CloudWatch submissions of Timer.getSnapshot(). Defaults to "timerSet" when using CloudWatchReporter constructors directly (backwards-compatibility) or when using the CloudWatchReporterBuilder

Returns:

this (for chaining)

withReporterFilter

public CloudWatchReporter withReporterFilter(com.google.common.base.Predicate<com.amazonaws.services.cloudwatch.model.MetricDatum> reporterFilter)

This filter is applied right before submission to CloudWatch. This filter can access decoded metric name elements such as MetricDatum.getDimensions().

Different from MetricFilter in that MetricFilter must operate on the encoded, single-string name (see MetricFilter.matches(String, Metric)), and this filter is applied before report(SortedMap, SortedMap, SortedMap, SortedMap, SortedMap) so that filtered metrics never reach that method in this reporter.

Defaults to Predicates.alwaysTrue() - i.e. do not remove any metrics from the submission due to this particular filter.

Parameters:

reporterFilter - to replace 'alwaysTrue()'

Returns:

this (for chaining)

report

public void report(java.util.SortedMap<java.lang.String,com.codahale.metrics.Gauge> gauges,
                   java.util.SortedMap<java.lang.String,com.codahale.metrics.Counter> counters,
                   java.util.SortedMap<java.lang.String,com.codahale.metrics.Histogram> histograms,
                   java.util.SortedMap<java.lang.String,com.codahale.metrics.Meter> meters,
                   java.util.SortedMap<java.lang.String,com.codahale.metrics.Timer> timers)

Specified by:

report in class com.codahale.metrics.ScheduledReporter