com.blacklocus.metrics

Class CloudWatchReporterBuilder

java.lang.Object

com.blacklocus.metrics.CloudWatchReporterBuilder

public class CloudWatchReporterBuilder
extends java.lang.Object

A fluent style builder for a CloudWatchReporter. withNamespace(String) is required. There are suitable defaults for all other fields.

Constructor Summary

Constructors

Constructor and Description
CloudWatchReporterBuilder()

Method Summary

Modifier and Type	Method and Description
CloudWatchReporter	build()
CloudWatchReporterBuilder	copy()
CloudWatchReporterBuilder	withClient(com.amazonaws.services.cloudwatch.AmazonCloudWatchAsync client)
CloudWatchReporterBuilder	withDimensions(java.lang.String dimensions)
CloudWatchReporterBuilder	withFilter(com.codahale.metrics.MetricFilter filter)
CloudWatchReporterBuilder	withNamespace(java.lang.String namespace)
CloudWatchReporterBuilder	withRegistry(com.codahale.metrics.MetricRegistry registry)
CloudWatchReporterBuilder	withReporterFilter(com.google.common.base.Predicate<com.amazonaws.services.cloudwatch.model.MetricDatum> reporterFilter) This filter is applied right before submission to CloudWatch.
CloudWatchReporterBuilder	withTimestampLocal(java.lang.Boolean timestampLocal)
CloudWatchReporterBuilder	withTypeDimName(java.lang.String typeDimName)
CloudWatchReporterBuilder	withTypeDimValCounterCount(java.lang.String typeDimValCounterCount)
CloudWatchReporterBuilder	withTypeDimValGauge(java.lang.String typeDimValGauge)
CloudWatchReporterBuilder	withTypeDimValHistoSamples(java.lang.String typeDimValHistoSamples)
CloudWatchReporterBuilder	withTypeDimValHistoStats(java.lang.String typeDimValHistoStats)
CloudWatchReporterBuilder	withTypeDimValMeterCount(java.lang.String typeDimValMeterCount)
CloudWatchReporterBuilder	withTypeDimValTimerSamples(java.lang.String typeDimValTimerSamples)
CloudWatchReporterBuilder	withTypeDimValTimerStats(java.lang.String typeDimValTimerStats)

Methods inherited from class java.lang.Object

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

Constructor Detail

CloudWatchReporterBuilder

public CloudWatchReporterBuilder()

Method Detail

withRegistry

public CloudWatchReporterBuilder withRegistry(com.codahale.metrics.MetricRegistry registry)

Parameters:

registry - of metrics for CloudWatchReporter to submit

Returns:

this (for chaining)

withNamespace

public CloudWatchReporterBuilder withNamespace(java.lang.String namespace)

Parameters:

namespace - metric namespace to use when submitting metrics to CloudWatch

Returns:

this (for chaining)

withClient

public CloudWatchReporterBuilder withClient(com.amazonaws.services.cloudwatch.AmazonCloudWatchAsync client)

Parameters:

client - CloudWatch client

Returns:

this (for chaining)

withFilter

public CloudWatchReporterBuilder withFilter(com.codahale.metrics.MetricFilter filter)

Parameters:

filter - which returns true for metrics that should be sent to CloudWatch

Returns:

this (for chaining)

withDimensions

public CloudWatchReporterBuilder withDimensions(java.lang.String dimensions)

Parameters:

dimensions - global dimensions in the form name=value that should be appended to all metrics submitted to CloudWatch

Returns:

this (for chaining)

withTimestampLocal

public CloudWatchReporterBuilder withTimestampLocal(java.lang.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)

Returns:

this (for chaining)

withTypeDimName

public CloudWatchReporterBuilder withTypeDimName(java.lang.String typeDimName)

Parameters:

typeDimName - name of the "metric type" dimension added to CloudWatch submissions. Defaults to when using the CloudWatchReporterBuilder

Returns:

this (for chaining)

withTypeDimValGauge

public CloudWatchReporterBuilder withTypeDimValGauge(java.lang.String typeDimValGauge)

Parameters:

typeDimValGauge - value of the "metric type" dimension added to CloudWatch submissions of Gauges. Defaults to when using the CloudWatchReporterBuilder

Returns:

this (for chaining)

withTypeDimValCounterCount

public CloudWatchReporterBuilder withTypeDimValCounterCount(java.lang.String typeDimValCounterCount)

Parameters:

typeDimValCounterCount - value of the "metric type" dimension added to CloudWatch submissions of Counter.getCount(). Defaults to when using the CloudWatchReporterBuilder

Returns:

this (for chaining)

withTypeDimValMeterCount

public CloudWatchReporterBuilder withTypeDimValMeterCount(java.lang.String typeDimValMeterCount)

Parameters:

typeDimValMeterCount - value of the "metric type" dimension added to CloudWatch submissions of Meter.getCount(). Defaults to when using the CloudWatchReporterBuilder

Returns:

this (for chaining)

withTypeDimValHistoSamples

public CloudWatchReporterBuilder withTypeDimValHistoSamples(java.lang.String typeDimValHistoSamples)

Parameters:

typeDimValHistoSamples - value of the "metric type" dimension added to CloudWatch submissions of Histogram.getCount(). Defaults to when using the CloudWatchReporterBuilder

Returns:

this (for chaining)

withTypeDimValHistoStats

public CloudWatchReporterBuilder withTypeDimValHistoStats(java.lang.String typeDimValHistoStats)

Parameters:

typeDimValHistoStats - value of the "metric type" dimension added to CloudWatch submissions of Histogram.getSnapshot(). Defaults to when using the CloudWatchReporterBuilder

Returns:

this (for chaining)

withTypeDimValTimerSamples

public CloudWatchReporterBuilder withTypeDimValTimerSamples(java.lang.String typeDimValTimerSamples)

Parameters:

typeDimValTimerSamples - value of the "metric type" dimension added to CloudWatch submissions of Timer.getCount(). Defaults to when using the CloudWatchReporterBuilder

Returns:

this (for chaining)

withTypeDimValTimerStats

public CloudWatchReporterBuilder withTypeDimValTimerStats(java.lang.String typeDimValTimerStats)

Parameters:

typeDimValTimerStats - value of the "metric type" dimension added to CloudWatch submissions of Timer.getSnapshot(). Defaults to when using the CloudWatchReporterBuilder

Returns:

this (for chaining)

withReporterFilter

public CloudWatchReporterBuilder 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(). true means to keep and submit the metric. false means to exclude it.

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 ScheduledReporter.report(SortedMap, SortedMap, SortedMap, SortedMap, SortedMap) so that filtered metrics never reach that method in CloudWatchReporter.

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)

copy

public CloudWatchReporterBuilder copy()

Returns:

a shallow copy of this builder

build

public CloudWatchReporter build()

Returns:

a new CloudWatchReporter instance based on the state of this builder