org.apache.dubbo.metrics

Class MetricName

java.lang.Object

org.apache.dubbo.metrics.MetricName

All Implemented Interfaces:

Comparable<MetricName>

public class MetricName
extends Object
implements Comparable<MetricName>

This class is based on Dropwizard metrics, see io/dropwizard/metrics/MetricName.java The following changes are made: * Add metric level * Cache the hash code

Field Summary

Fields

Modifier and Type	Field and Description
static MetricName	EMPTY
static Map<String,String>	EMPTY_TAGS
static String	SEPARATOR

Constructor Summary

Constructors

Constructor and Description
MetricName()
MetricName(String key)
MetricName(String key, Map<String,String> tags)
MetricName(String key, Map<String,String> tags, MetricLevel level)
MetricName(String key, MetricLevel level)

Method Summary

Modifier and Type	Method and Description
static MetricName	build(String... parts) Build a new metric name using the specific path components.
int	compareTo(MetricName o)
boolean	equals(Object obj)
String	getKey()
MetricLevel	getMetricLevel() Return the level of this metric The level indicates the importance of the metric
Map<String,String>	getTags()
int	hashCode()
static MetricName	join(MetricName... parts) Join the specified set of metric names.
MetricName	level(MetricLevel level) Metric level can be changed during runtime
MetricName	resolve(String p)
MetricName	resolve(String p, boolean inheritTags) Build the MetricName that is this with another path appended to it.
MetricName	tag(Map<String,String> add) Add tags to a metric name and return the newly created MetricName.
MetricName	tag(String... pairs) Same as tag(Map), but takes a variadic list of arguments.
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

SEPARATOR

public static final String SEPARATOR

See Also:

Constant Field Values

EMPTY_TAGS

public static final Map<String,String> EMPTY_TAGS

EMPTY

public static final MetricName EMPTY

Constructor Detail

MetricName

public MetricName()

MetricName

public MetricName(String key)

MetricName

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

MetricName

public MetricName(String key,
                  MetricLevel level)

MetricName

public MetricName(String key,
                  Map<String,String> tags,
                  MetricLevel level)

Method Detail

getKey

public String getKey()

getTags

public Map<String,String> getTags()

getMetricLevel

public MetricLevel getMetricLevel()

Return the level of this metric The level indicates the importance of the metric

Returns:

when level tag do not exist or illegal tag, will return null.

level

public MetricName level(MetricLevel level)

Metric level can be changed during runtime

Parameters:

level - the level to set

resolve

public MetricName resolve(String p)

See Also:

#resolve(String, boolean)}

resolve

public MetricName resolve(String p,
                          boolean inheritTags)

Build the MetricName that is this with another path appended to it. The new MetricName inherits the tags of this one.

Parameters:

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

inheritTags - if true, tags will be inherited

Returns:

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

tag

public MetricName tag(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.

tag

public MetricName tag(String... pairs)

Same as tag(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:

tag(Map)

join

public static MetricName join(MetricName... 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 MetricName 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(MetricName o)

Specified by:

compareTo in interface Comparable<MetricName>