com.bigdata.ganglia

Interface IGangliaMessage

All Known Subinterfaces:

IGangliaMetadataMessage, IGangliaMetricMessage, IGangliaRequestMessage

All Known Implementing Classes:

AbstractGangliaMessage, GangliaMetadataMessage, GangliaMetricMessage, GangliaRequestMessage, RichMetricMessage

public interface IGangliaMessage

A ganglia message.

Method Summary

Methods

Modifier and Type	Method and Description
String	getHostName() The name of the host for which the metric was reported.
String	getMetricName() The name of the metric (this needs to be clean for use in a file system so the application name of the metric needs to be munged before it is saved here).
GangliaMessageTypeEnum	getRecordType() The code for the type of message.
boolean	isMetricMetadata() Return true iff this message contains the metadata for a metric (the metric declaration).
boolean	isMetricRequest() Return true iff this message is a request for a metric.
boolean	isMetricValue() Return true if this message represents a metric value.
boolean	isSpoof() true iff this is a spoofed message.

Method Detail

getRecordType

GangliaMessageTypeEnum getRecordType()

The code for the type of message.

getHostName

String getHostName()

The name of the host for which the metric was reported.

Note: When isSpoof() reports true this will be ip:host.

getMetricName

String getMetricName()

The name of the metric (this needs to be clean for use in a file system so the application name of the metric needs to be munged before it is saved here).

isMetricMetadata

boolean isMetricMetadata()

Return true iff this message contains the metadata for a metric (the metric declaration).

See Also:

GangliaMessageTypeEnum.METADATA

isMetricRequest

boolean isMetricRequest()

Return true iff this message is a request for a metric.

See Also:

GangliaMessageTypeEnum.REQUEST

isMetricValue

boolean isMetricValue()

Return true if this message represents a metric value.

isSpoof

boolean isSpoof()

true iff this is a spoofed message.

Note: Spoof messages format getHostName() as ip:host and provide a means to fake metrics for a host which is down (or which is not running ganglia).