com.spotify.metrics.core

Class MetricId

java.lang.Object

com.spotify.metrics.core.MetricId

All Implemented Interfaces:

Comparable<MetricId>

public class MetricId
extends Object
implements Comparable<MetricId>

A metric name with the ability to include semantic tags.

Instances of this class are immutable. There are methods that copy-then-modify MetricId's, these should be used sparingly and not in performance critical sections since they are slow.

If you find the need to mutate a MetricId frequently, consider using MetricIdMutator which will cache values for you.

This replaces the previous style where metric names where strictly dot-separated strings.

Author:

udoprog

Field Summary

Fields

Modifier and Type	Field and Description
static MetricId	EMPTY
static SortedMap<String,String>	EMPTY_TAGS
static String	SEPARATOR

Constructor Summary

Constructors

Constructor and Description
MetricId()
MetricId(String key)
MetricId(String key, Map<String,String> tags)

Method Summary

Modifier and Type	Method and Description
static MetricId	build(String... parts) Build a new metric name using the specific path components.
int	compareTo(MetricId o)
boolean	equals(Object obj)
String	getKey() Get the current key of the metric id.
Map<String,String>	getTags() Get the current set of tags.
int	hashCode()
static MetricId	join(MetricId... parts) Join the specified set of metric names.
MetricId	resolve(String part) Build the MetricName that is this with another path appended to it.
MetricId	tagged(Map<String,String> add) Add tags to a metric name and return the newly created MetricName.
MetricId	tagged(String... pairs) Same as tagged(Map), but takes a variadic list of arguments.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

SEPARATOR

public static final String SEPARATOR

See Also:

Constant Field Values

EMPTY_TAGS

public static final SortedMap<String,String> EMPTY_TAGS

EMPTY

public static final MetricId EMPTY

Constructor Detail

MetricId

public MetricId()

MetricId

public MetricId(String key)

MetricId

public MetricId(String key,
                Map<String,String> tags)

Method Detail

getKey

public String getKey()

Get the current key of the metric id.

Returns:

The key of the metric id.

getTags

public Map<String,String> getTags()

Get the current set of tags.

Returns:

The tags of the metric id.

resolve

public MetricId resolve(String part)

Build the MetricName that is this with another path appended to it.

The new MetricName inherits the tags of this one.

Parameters:

part - The extra path element to add to the new metric.

Returns:

A new metric name relative to the original by the path specified in p.

tagged

public MetricId tagged(Map<String,String> add)

Add tags to a metric name and return the newly created MetricName.

Parameters:

add - Tags to add.

Returns:

A newly created metric name with the specified tags associated with it.

tagged

public MetricId tagged(String... pairs)

Same as tagged(Map), but takes a variadic list of arguments.

Parameters:

pairs - An even list of strings acting as key-value pairs.

Returns:

A newly created metric name with the specified tags associated with it.

See Also:

tagged(Map)

join

public static MetricId join(MetricId... parts)

Join the specified set of metric names.

Parameters:

parts - Multiple metric names to join using the separator.

Returns:

A newly created metric name which has the name of the specified parts and includes all tags of all child metric names.

build

public static MetricId build(String... parts)

Build a new metric name using the specific path components.

Parameters:

parts - Path of the new metric name.

Returns:

A newly created metric name with the specified path.

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

compareTo

public int compareTo(MetricId o)

Specified by:

compareTo in interface Comparable<MetricId>