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 METRIC_TYPE_DIMENSION. 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	METRIC_TYPE_DIMENSION Key of Dimension.name for the type of metric submission, e.g.
static java.lang.String	NAME_DIMENSION_SEPARATOR Separator of key and value segments of a metric name.
static java.lang.String	NAME_PERMUTE_MARKER If any token, whether a simple string or a dimension pair ends with this marker, then metrics will be sent once with and once without.
static java.lang.String	NAME_TOKEN_DELIMITER
static java.lang.String	NAME_TOKEN_DELIMITER_RGX Delimiter of tokens in the metric name.
static java.lang.String	VALID_DIMENSION_PART_RGX
static java.lang.String	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)

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

public static final java.lang.String NAME_TOKEN_DELIMITER_RGX

Delimiter of tokens in the metric name. Plain tokens will be retained as the CloudWatch "Metric Name".

See Also:

Constant Field Values

NAME_TOKEN_DELIMITER

public static final java.lang.String NAME_TOKEN_DELIMITER

See Also:

Constant Field Values

NAME_DIMENSION_SEPARATOR

public static final java.lang.String NAME_DIMENSION_SEPARATOR

Separator of key and value segments of a metric name. These segments will be split into the key and value of a CloudWatch Dimension.

See Also:

Constant Field Values

NAME_PERMUTE_MARKER

public static final java.lang.String NAME_PERMUTE_MARKER

If any token, whether a simple string or a dimension pair ends with this marker, then metrics will be sent once with and once without.

See Also:

Constant Field Values

METRIC_TYPE_DIMENSION

public static final java.lang.String METRIC_TYPE_DIMENSION

Key of Dimension.name for the type of metric submission, e.g. gauge, counterSum, meterSum, ...

See Also:

Constant Field Values

VALID_NAME_TOKEN_RGX

public static final java.lang.String VALID_NAME_TOKEN_RGX

See Also:

Constant Field Values

VALID_DIMENSION_PART_RGX

public static final java.lang.String VALID_DIMENSION_PART_RGX

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

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

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

Method Detail

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