Package com.bigdata.ganglia

This package provides a full implementation of the ganglia protocol, including the ability to listen and report on metrics, metadata, and metadata requests.

See: Description

Interface Summary

Interface	Description
IGangliaAttributes	Attributes for IGangliaMetadataMessage records.
IGangliaDefaults	Well known configuration defaults and constants for Ganglia.
IGangliaMessage	A ganglia message.
IGangliaMessageDecoder	Decoder interface for ganglia wire format messages.
IGangliaMessageEncoder	Interface for generating Ganglia message according to some version of the ganglia wire protocol.
IGangliaMessageHandler	Interface for handling Ganglia messages.
IGangliaMetadataFactory	A factory for registering application metrics dynamically.
IGangliaMetadataMessage	A Ganglia 3.1 message representing the declaration of a metric.
IGangliaMetricMessage	A ganglia message representing a metric value.
IGangliaMetricsCollector	Interface for collecting metrics from a local (embedded) process.
IGangliaMetricsReporter	Interface for reporting metrics to a local ganglia service.
IGangliaRequestMessage	A ganglia metadata request message.
IGangliaState	A read-only view of the soft state of the cluster as maintained through the ganglia protocol.
IHostReport	Interface for a snapshot of metrics for a given host.
ITimestampMetricValue	A read-only interface for a reported or observed metric value with a timestamp and a reference to the IGangliaMetadataMessage for that metric.

Class Summary

Class	Description
AbstractGangliaMessage	Base class for ganglia 3.1 wire format messages.
AbstractMetrics
DefaultMetadataFactory	Default factory will always produce an IGangliaMetadataMessage for a metric.
GangliaCoreMetricDecls	Utility class to declare the ganglia core metrics.
GangliaListener	Class listens in to the Ganglia UDP protocol, decodes received messages, and dispatches them to an IGangliaMessageHandler.
GangliaMessageDecoder31	Class decodes a Ganglia 3.1 wire format message.
GangliaMessageEncoder25	An earlier version of the Ganglia protocol.
GangliaMessageEncoder31	Class for generating Ganglia 3.1 protocol messages.
GangliaMetadataFactory	A factory which can be extended by an application.
GangliaMetadataMessage	A ganglia metric metadata (aka declaration) record.
GangliaMetricMessage	A ganglia 3.1 metric message.
GangliaMunge
GangliaRequestMessage	A ganglia request for a metric.
GangliaSender	Class for sending metrics to Ganglia.
GangliaService	A full ganglia-aware service suitable for embedding with a Java application.
GangliaState	The metadata and metric state for a ganglia service, including the metadata for all known metrics and the metrics for all known metrics on all known hosts.
HostReport	A host report.
HostReportComparator	Orders IHostReports.
NOPMetadataFactory	NOP factory.
RichMetricFactory	Factory associates the IGangliaMetadataMessage with the IGangliaMetricMessage.
RichMetricMessage	Class bundles together an IGangliaMetricMessage with the IGangliaMetadataMessage which provides its declaration.
TimestampMetricValue	A reported or observed metric value with a timestamp.

Enum Summary

Enum	Description
GangliaMessageTypeEnum	Type safe enumeration of the Ganglia 3.1 wire format Ganglia_msg_formats from lib/gm_protocol.h (generated when you build ganglia from the source).
GangliaSlopeEnum	This slope is a metadata parameter which ganglia carries for the rrdtool integration.

Package com.bigdata.ganglia Description

This package provides a full implementation of the ganglia protocol, including the ability to listen and report on metrics, metadata, and metadata requests.

Applications embed a GangliaService and participate in a ganglia network. The GangliaService provides hooks which an application can use to register IGangliaMetricsCollectors. Applications can provide metadata declarations for custom metrics by implementing the IGangliaMetadataFactory interface.