com.bigdata.ganglia

Interface IGangliaMetadataMessage

All Superinterfaces:

IGangliaMessage

All Known Implementing Classes:

GangliaMetadataMessage

public interface IGangliaMetadataMessage
extends IGangliaMessage

A Ganglia 3.1 message representing the declaration of a metric.

Method Summary

Methods

Modifier and Type	Method and Description
String	getDescription() Return the value of the well-known attribute IGangliaAttributes.ATTR_DESC.
int	getDMax() The maximum age in seconds before a metric will be deleted (aka Delete Max).
Map<String,String[]>	getExtraValues() Zero or more additional name-value[] pairs serialized with this message.
String	getFirstValue(String key) Return the first value for the given key from the getExtraValues().
String[]	getGroups() Return the value of the well-known attribute IGangliaAttributes.ATTR_TITLE.
String	getMetricName2() The metric name (this is represented twice in the Ganglia 3.1 wire format: once in the metric_id header and once in the metadata record; both values SHOULD be the same).
GangliaMessageTypeEnum	getMetricType() The data type declaration for the metric.
GangliaSlopeEnum	getSlope() Hint for rrdtool visualization of metric values.
String	getTitle() Return the value of the well-known attribute IGangliaAttributes.ATTR_TITLE.
int	getTMax() The maximum advisory delay in seconds before a metric value would become stale.
String	getUnits() The units in which the metric values are expressed.
boolean	isChanged(Object oldValue, Object newValue) Return true iff the newValue differs significantly from the old value.
Object	translateValue(Object value) Return a value which may have been scaled and/or offset in order to align the value with the metric declaration.

Methods inherited from interface com.bigdata.ganglia.IGangliaMessage

getHostName, getMetricName, getRecordType, isMetricMetadata, isMetricRequest, isMetricValue, isSpoof

Method Detail

getMetricType

GangliaMessageTypeEnum getMetricType()

The data type declaration for the metric.

getMetricName2

String getMetricName2()

The metric name (this is represented twice in the Ganglia 3.1 wire format: once in the metric_id header and once in the metadata record; both values SHOULD be the same).

See Also:

IGangliaMessage.getMetricName()

getUnits

String getUnits()

The units in which the metric values are expressed.

getSlope

GangliaSlopeEnum getSlope()

Hint for rrdtool visualization of metric values.

getTMax

int getTMax()

The maximum advisory delay in seconds before a metric value would become stale. For the metric sending, this is also the maximum delay before it should retransmit a metric value which is unchanged from its last reported value.

getDMax

int getDMax()

The maximum age in seconds before a metric will be deleted (aka Delete Max).

getExtraValues

Map<String,String[]> getExtraValues()

Zero or more additional name-value[] pairs serialized with this message. This may be used to group metrics, add nice titles, provide in-band descriptions of metrics, etc.

getFirstValue

String getFirstValue(String key)

Return the first value for the given key from the getExtraValues().

Parameters:

key - The key.

Returns:

The first value for that key -or- null if there are no values for that key.

getGroups

String[] getGroups()

Return the value of the well-known attribute IGangliaAttributes.ATTR_TITLE.

Returns:

The value of the TITLE attribute if present and otherwise null.

getTitle

String getTitle()

Return the value of the well-known attribute IGangliaAttributes.ATTR_TITLE.

Returns:

The value of the IGangliaAttributes.ATTR_TITLE attribute if present and otherwise null.

getDescription

String getDescription()

Return the value of the well-known attribute IGangliaAttributes.ATTR_DESC.

Returns:

The value of the IGangliaAttributes.ATTR_DESC attribute if present and otherwise null.

translateValue

Object translateValue(Object value)

Return a value which may have been scaled and/or offset in order to align the value with the metric declaration. Use cases for translation include changing the units in which a metric is collected (e.g., bytes versus kilobytes) to conform with ganglia or translating the metric from an offset (e.g., 1-foo).

Parameters:

value - The value.

Returns:

The translated value.

isChanged

boolean isChanged(Object oldValue,
                Object newValue)

Return true iff the newValue differs significantly from the old value.

Parameters:

oldValue - The old value and never null.

newValue - The new value and never null.

Returns:

true iff there is a significant difference.