Package org.apache.hadoop.yarn.api.records.timelineservice

Class TimelineMetric

java.lang.Object

org.apache.hadoop.yarn.api.records.timelineservice.TimelineMetric

@Public
@Unstable
public class TimelineMetric
extends java.lang.Object

This class contains the information of a metric that is related to some entity. Metric can either be a time series or single value.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	TimelineMetric.Type	Type of metric.

Constructor Summary

Constructors

Constructor	Description
TimelineMetric()
TimelineMetric(TimelineMetric.Type type)

Method Summary

Modifier and Type	Method	Description
void	addValue(long timestamp, java.lang.Number value)
void	addValues(java.util.Map<java.lang.Long,java.lang.Number> vals)
static TimelineMetric	aggregateTo(TimelineMetric incomingMetric, TimelineMetric baseAggregatedMetric)	Aggregate an incoming metric to the base aggregated metric with the given operation state in a stateless fashion.
static TimelineMetric	aggregateTo(TimelineMetric incomingMetric, TimelineMetric baseAggregatedMetric, java.util.Map<java.lang.Object,java.lang.Object> state)	Aggregate an incoming metric to the base aggregated metric with the given operation state.
boolean	equals(java.lang.Object o)
java.lang.String	getId()
static TimelineMetric	getLatestSingleValueMetric(TimelineMetric metric)	Get the latest timeline metric as single value type.
TimelineMetricOperation	getRealtimeAggregationOp()	Get the real time aggregation operation of this metric.
long	getSingleDataTimestamp()	Get single data timestamp of the metric.
java.lang.Number	getSingleDataValue()	Get single data value of the metric.
TimelineMetric.Type	getType()
java.util.Map<java.lang.Long,java.lang.Number>	getValues()
java.util.TreeMap<java.lang.Long,java.lang.Number>	getValuesJAXB()
int	hashCode()
boolean	isValid()
void	setId(java.lang.String metricId)
void	setRealtimeAggregationOp(TimelineMetricOperation op)	Set the real time aggregation operation of this metric.
void	setType(TimelineMetric.Type metricType)
void	setValues(java.util.Map<java.lang.Long,java.lang.Number> vals)
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

TimelineMetric

public TimelineMetric()

TimelineMetric

public TimelineMetric(TimelineMetric.Type type)

Method Detail

getType

public TimelineMetric.Type getType()

setType

public void setType(TimelineMetric.Type metricType)

getId

public java.lang.String getId()

setId

public void setId(java.lang.String metricId)

getRealtimeAggregationOp

public TimelineMetricOperation getRealtimeAggregationOp()

Get the real time aggregation operation of this metric.

Returns:

Real time aggregation operation

setRealtimeAggregationOp

public void setRealtimeAggregationOp(TimelineMetricOperation op)

Set the real time aggregation operation of this metric.

Parameters:

op - A timeline metric operation that the metric should perform on real time aggregations

getValuesJAXB

@Private
public java.util.TreeMap<java.lang.Long,java.lang.Number> getValuesJAXB()

getValues

public java.util.Map<java.lang.Long,java.lang.Number> getValues()

setValues

public void setValues(java.util.Map<java.lang.Long,java.lang.Number> vals)

addValues

public void addValues(java.util.Map<java.lang.Long,java.lang.Number> vals)

addValue

public void addValue(long timestamp,
                     java.lang.Number value)

isValid

public boolean isValid()

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

getLatestSingleValueMetric

public static TimelineMetric getLatestSingleValueMetric(TimelineMetric metric)

Get the latest timeline metric as single value type.

Parameters:

metric - Incoming timeline metric

Returns:

The latest metric in the incoming metric

getSingleDataTimestamp

public long getSingleDataTimestamp()

Get single data timestamp of the metric.

Returns:

the single data timestamp

getSingleDataValue

public java.lang.Number getSingleDataValue()

Get single data value of the metric.

Returns:

the single data value

aggregateTo

public static TimelineMetric aggregateTo(TimelineMetric incomingMetric,
                                         TimelineMetric baseAggregatedMetric)

Aggregate an incoming metric to the base aggregated metric with the given operation state in a stateless fashion. The assumption here is baseAggregatedMetric and latestMetric should be single value data if not null.

Parameters:

incomingMetric - Incoming timeline metric to aggregate

baseAggregatedMetric - Base timeline metric

Returns:

Result metric after aggregation

aggregateTo

public static TimelineMetric aggregateTo(TimelineMetric incomingMetric,
                                         TimelineMetric baseAggregatedMetric,
                                         java.util.Map<java.lang.Object,java.lang.Object> state)

Aggregate an incoming metric to the base aggregated metric with the given operation state. The assumption here is baseAggregatedMetric and latestMetric should be single value data if not null.

Parameters:

incomingMetric - Incoming timeline metric to aggregate

baseAggregatedMetric - Base timeline metric

state - Operation state

Returns:

Result metric after aggregation