alluxio.metrics

Class Metric

java.lang.Object

alluxio.metrics.Metric

All Implemented Interfaces:

Serializable

public final class Metric
extends Object
implements Serializable

A metric of a given instance. The instance can be master, worker, or client.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static String	TAG_SEPARATOR

Constructor Summary

Constructors

Constructor and Description
Metric(MetricsSystem.InstanceType instanceType, String hostname, MetricType metricType, String name, Double value) Constructs a Metric instance.
Metric(MetricsSystem.InstanceType instanceType, String hostname, String id, MetricType metricType, String name, Double value) Constructs a Metric instance.

Method Summary

Modifier and Type	Method and Description
void	addTag(String name, String value) Adds a new tag.
void	addValue(double delta) Add metric value delta to the existing value.
boolean	equals(Object other)
static Metric	from(String fullName, double value, MetricType metricType) Creates the metric from the full name and the value.
static Metric	fromProto(Metric metric) Constructs the metric object from the proto format.
String	getFullMetricName()
String	getHostname()
String	getInstanceId()
MetricsSystem.InstanceType	getInstanceType()
static String	getMetricNameWithTags(String name, String... tags) Gets the metric name with the appendix of tags.
static String	getMetricNameWithUserTag(String metricName, String userName) Gets a metric name with a specific user tag.
MetricType	getMetricType()
String	getName()
Map<String,String>	getTags()
double	getValue()
int	hashCode()
void	setInstanceId(String instanceId) Sets the instance id.
void	setValue(double value) Set the metric value.
Metric	toProto()
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

TAG_SEPARATOR

public static final String TAG_SEPARATOR

See Also:

Constant Field Values

Constructor Detail

Metric

public Metric(MetricsSystem.InstanceType instanceType,
              String hostname,
              MetricType metricType,
              String name,
              Double value)

Constructs a Metric instance.

Parameters:

instanceType - the instance type

hostname - the hostname

metricType - the type of the metric

name - the metric name

value - the value

Metric

public Metric(MetricsSystem.InstanceType instanceType,
              String hostname,
              String id,
              MetricType metricType,
              String name,
              Double value)

Constructs a Metric instance.

Parameters:

instanceType - the instance type

hostname - the hostname

id - the instance id

metricType - the type of the metric

name - the metric name

value - the value

Method Detail

addValue

public void addValue(double delta)

Add metric value delta to the existing value. This method should only be used by MetricsStore

Parameters:

delta - value to add

setValue

public void setValue(double value)

Set the metric value. This method should only be used by MetricsStore

Parameters:

value - value to set

getValue

public double getValue()

Returns:

the metric value

getInstanceType

public MetricsSystem.InstanceType getInstanceType()

Returns:

the instance type

addTag

public void addTag(String name,
                   String value)

Adds a new tag. If the tag name already exists, it will be replaced.

Parameters:

name - the tag name

value - the tag value

getHostname

public String getHostname()

Returns:

the hostname

getMetricType

public MetricType getMetricType()

Returns:

the hostname

getName

public String getName()

Returns:

the metric name

getInstanceId

public String getInstanceId()

Returns:

the instance id

getTags

public Map<String,String> getTags()

Returns:

the tags

setInstanceId

public void setInstanceId(String instanceId)

Sets the instance id.

Parameters:

instanceId - the instance id;

equals

public boolean equals(Object other)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getFullMetricName

public String getFullMetricName()

Returns:

the fully qualified metric name, which is of pattern instance.[hostname-id:instanceId.]name[.tagName:tagValue]*, where the tags are appended at the end

toProto

public Metric toProto()

Returns:

the proto object it converts to. Note the value must be either integer or long

getMetricNameWithTags

public static String getMetricNameWithTags(String name,
                                           String... tags)

Gets the metric name with the appendix of tags. The returned name is of the pattern name[.tagName:tagValue]*.

Parameters:

name - the metric name

tags - the tag name and tag value pairs

Returns:

the name with the tags appended

getMetricNameWithUserTag

public static String getMetricNameWithUserTag(String metricName,
                                              String userName)

Gets a metric name with a specific user tag.

Parameters:

metricName - the name of the metric

userName - the user

Returns:

a metric name with the user tagged

from

public static Metric from(String fullName,
                          double value,
                          MetricType metricType)

Creates the metric from the full name and the value.

Parameters:

fullName - the full name

value - the value

metricType - the type of metric that is being created

Returns:

the created metric

fromProto

public static Metric fromProto(Metric metric)

Constructs the metric object from the proto format.

Parameters:

metric - the metric in proto format

Returns:

the constructed metric

toString

public String toString()

Overrides:

toString in class Object