com.blacklocus.metrics

Class MetricNameBuilder

java.lang.Object

com.blacklocus.metrics.MetricNameBuilder

public class MetricNameBuilder
extends java.lang.Object

A builder for the metrics name syntax defined by this module. Useful when programmatically constructing metric names.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MetricNameBuilder.MetricsNameSyntaxException

Constructor Summary

Constructors

Constructor and Description
MetricNameBuilder()
MetricNameBuilder(java.lang.String nameSpec)

Method Summary

Modifier and Type	Method and Description
MetricNameBuilder	add(java.lang.String nameSpec)
MetricNameBuilder	addDimension(com.amazonaws.services.cloudwatch.model.Dimension dimension) addDimension(Dimension, boolean) without permutation (false)
MetricNameBuilder	addDimension(com.amazonaws.services.cloudwatch.model.Dimension dimension, boolean permute) Passes into addDimension(String, String, boolean)
MetricNameBuilder	addDimension(java.lang.String name, java.lang.String value) addDimension(String, String, boolean) without permutation (false)
MetricNameBuilder	addDimension(java.lang.String name, java.lang.String value, boolean permute)
MetricNameBuilder	addNameToken(java.lang.String nameToken)
MetricNameBuilder	addNameToken(java.lang.String nameToken, boolean permute)
java.lang.String	build()
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

MetricNameBuilder

public MetricNameBuilder()

MetricNameBuilder

public MetricNameBuilder(java.lang.String nameSpec)

Method Detail

addNameToken

public MetricNameBuilder addNameToken(java.lang.String nameToken)
                               throws MetricNameBuilder.MetricsNameSyntaxException

Parameters:

nameToken - must be a single valid name segment which is summarized by the regex CloudWatchReporter.VALID_NAME_TOKEN_RGX (it may end in the permute operator).

Returns:

this for chaining

Throws:

MetricNameBuilder.MetricsNameSyntaxException - on validation failure

addNameToken

public MetricNameBuilder addNameToken(java.lang.String nameToken,
                                      boolean permute)
                               throws MetricNameBuilder.MetricsNameSyntaxException

Parameters:

nameToken - must be a single valid name segment which is summarized by the regex CloudWatchReporter.VALID_NAME_TOKEN_RGX (it may end in the permute operator).

permute - whether or not this token should permute

Returns:

this for chaining

Throws:

MetricNameBuilder.MetricsNameSyntaxException - on validation failure

add

public MetricNameBuilder add(java.lang.String nameSpec)
                      throws MetricNameBuilder.MetricsNameSyntaxException

Parameters:

nameSpec - a string of encoded name tokens and dimensions, e.g. "MyMetric SomeTag* color=green machine=1.2.3.4*". A metric name of this format is already suitable for direct use with metrics reported by the CloudWatchReporter and demuxes into corresponding dimensions and permutations. There is no need to use a MetricsNameBuilder if you already have the completed string. Set it directly to be the metric name, e.g.

                     metricRegistry.counter("MyMetric SomeTag* color=green machine=1.2.3.4*").inc();
                 

Returns:

this for chaining

Throws:

MetricNameBuilder.MetricsNameSyntaxException - on validation failure

addDimension

public MetricNameBuilder addDimension(com.amazonaws.services.cloudwatch.model.Dimension dimension)
                               throws MetricNameBuilder.MetricsNameSyntaxException

addDimension(Dimension, boolean) without permutation (false)

Returns:

this for chaining

Throws:

MetricNameBuilder.MetricsNameSyntaxException - on validation failure

addDimension

public MetricNameBuilder addDimension(com.amazonaws.services.cloudwatch.model.Dimension dimension,
                                      boolean permute)
                               throws MetricNameBuilder.MetricsNameSyntaxException

Passes into addDimension(String, String, boolean)

Returns:

this for chaining

Throws:

MetricNameBuilder.MetricsNameSyntaxException - on validation failure

addDimension

public MetricNameBuilder addDimension(java.lang.String name,
                                      java.lang.String value)
                               throws MetricNameBuilder.MetricsNameSyntaxException

addDimension(String, String, boolean) without permutation (false)

Returns:

this for chaining

Throws:

MetricNameBuilder.MetricsNameSyntaxException - on validation failure

addDimension

public MetricNameBuilder addDimension(java.lang.String name,
                                      java.lang.String value,
                                      boolean permute)
                               throws MetricNameBuilder.MetricsNameSyntaxException

Parameters:

name - of dimension

value - of dimension

permute - permutability of dimension

Returns:

this for chaining

Throws:

MetricNameBuilder.MetricsNameSyntaxException - on validation failure

build

public java.lang.String build()

Returns:

properly formatted metric name for use with the MetricRegistry. The CloudWatchReporter will be able to demux this name spec into corresponding permutable name tokens and dimensions.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

Returns:

properly formatted metric name for use with the MetricRegistry. The CloudWatchReporter will be able to demux this name spec into corresponding permutable name tokens and dimensions.