com.bigdata.ganglia

Class GangliaCoreMetricDecls

java.lang.Object

com.bigdata.ganglia.AbstractMetrics

com.bigdata.ganglia.GangliaCoreMetricDecls

All Implemented Interfaces:

IGangliaAttributes

Direct Known Subclasses:

BigdataMetadataFactory

public class GangliaCoreMetricDecls
extends AbstractMetrics

Utility class to declare the ganglia core metrics. These declarations were derived by monitoring IGangliaMetadataMessages as generated by ganglia services.

Note: GangliaService can (and will) pickup metadata declarations from the ganglia network, including running gmond instances. Normally, the GangliaService will wait a bit until these declarations are discovered from the ganglia network. That way it picks up the values of TMax and DMax which are already configured auto-magically. The role of this class is to get those definitions right in case there is no ganglia network running from which it can capture the as configured metric metadata declarations.

Metadata capture

The following is a capture of the metadata records as generated by gmond and captured by the GangliaListener. This forms the basis of the declarations in this class.

 GangliaMetadataMessage{ recordType=METADATA, hostName=bigdata08, metricName=heartbeat, spoof=false, metricType=UINT32, metricName2=heartbeat, units=, slope=unspecified, tmax=20, dmax=0, extraValues={TITLE="heartbeat"},DESC="Last heartbeat"},GROUP="core"}}}
 GangliaMetadataMessage{ recordType=METADATA, hostName=bigdata08, metricName=cpu_num, spoof=false, metricType=UINT16, metricName2=cpu_num, units=CPUs, slope=zero, tmax=1200, dmax=0, extraValues={TITLE="CPU Count"},DESC="Total number of CPUs"},GROUP="cpu"}}}
 GangliaMetadataMessage{ recordType=METADATA, hostName=bigdata08, metricName=cpu_speed, spoof=false, metricType=UINT32, metricName2=cpu_speed, units=MHz, slope=zero, tmax=1200, dmax=0, extraValues={TITLE="CPU Speed"},DESC="CPU Speed in terms of MHz"},GROUP="cpu"}}}
 GangliaMetadataMessage{ recordType=METADATA, hostName=bigdata08, metricName=mem_total, spoof=false, metricType=FLOAT, metricName2=mem_total, units=KB, slope=zero, tmax=1200, dmax=0, extraValues={TITLE="Memory Total"},DESC="Total amount of memory displayed in KBs"},GROUP="memory"}}}
 GangliaMetadataMessage{ recordType=METADATA, hostName=bigdata08, metricName=swap_total, spoof=false, metricType=FLOAT, metricName2=swap_total, units=KB, slope=zero, tmax=1200, dmax=0, extraValues={TITLE="Swap Space Total"},DESC="Total amount of swap space displayed in KBs"},GROUP="memory"}}}
 GangliaMetadataMessage{ recordType=METADATA, hostName=bigdata08, metricName=boottime, spoof=false, metricType=UINT32, metricName2=boottime, units=s, slope=zero, tmax=1200, dmax=0, extraValues={TITLE="Last Boot Time"},DESC="The last time that the system was started"},GROUP="system"}}}
 GangliaMetadataMessage{ recordType=METADATA, hostName=bigdata08, metricName=machine_type, spoof=false, metricType=STRING, metricName2=machine_type, units=, slope=zero, tmax=1200, dmax=0, extraValues={TITLE="Machine Type"},DESC="System architecture"},GROUP="system"}}}
 GangliaMetadataMessage{ recordType=METADATA, hostName=bigdata08, metricName=os_name, spoof=false, metricType=STRING, metricName2=os_name, units=, slope=zero, tmax=1200, dmax=0, extraValues={TITLE="Operating System"},DESC="Operating system name"},GROUP="system"}}}
 GangliaMetadataMessage{ recordType=METADATA, hostName=bigdata08, metricName=os_release, spoof=false, metricType=STRING, metricName2=os_release, units=, slope=zero, tmax=1200, dmax=0, extraValues={TITLE="Operating System Release"},DESC="Operating system release date"},GROUP="system"}}}
 GangliaMetadataMessage{ recordType=METADATA, hostName=bigdata08, metricName=location, spoof=false, metricType=STRING, metricName2=location, units=(x,y,z), slope=unspecified, tmax=1200, dmax=0, extraValues={TITLE="Location"},DESC="Location of the machine"},GROUP="core"}}}
 GangliaMetadataMessage{ recordType=METADATA, hostName=bigdata08, metricName=gexec, spoof=false, metricType=STRING, metricName2=gexec, units=, slope=zero, tmax=300, dmax=0, extraValues={TITLE="Gexec Status"},DESC="gexec available"},GROUP="core"}}}
 GangliaMetadataMessage{ recordType=METADATA, hostName=bigdata08, metricName=cpu_user, spoof=false, metricType=FLOAT, metricName2=cpu_user, units=%, slope=both, tmax=90, dmax=0, extraValues={TITLE="CPU User"},DESC="Percentage of CPU utilization that occurred while executing at the user level"},GROUP="cpu"}}}
 GangliaMetadataMessage{ recordType=METADATA, hostName=bigdata08, metricName=cpu_system, spoof=false, metricType=FLOAT, metricName2=cpu_system, units=%, slope=both, tmax=90, dmax=0, extraValues={TITLE="CPU System"},DESC="Percentage of CPU utilization that occurred while executing at the system level"},GROUP="cpu"}}}
 GangliaMetadataMessage{ recordType=METADATA, hostName=bigdata08, metricName=cpu_idle, spoof=false, metricType=FLOAT, metricName2=cpu_idle, units=%, slope=both, tmax=90, dmax=0, extraValues={TITLE="CPU Idle"},DESC="Percentage of time that the CPU or CPUs were idle and the system did not have an outstanding disk I/O request"},GROUP="cpu"}}}
 GangliaMetadataMessage{ recordType=METADATA, hostName=bigdata08, metricName=cpu_nice, spoof=false, metricType=FLOAT, metricName2=cpu_nice, units=%, slope=both, tmax=90, dmax=0, extraValues={TITLE="CPU Nice"},DESC="Percentage of CPU utilization that occurred while executing at the user level with nice priority"},GROUP="cpu"}}}
 GangliaMetadataMessage{ recordType=METADATA, hostName=bigdata08, metricName=cpu_aidle, spoof=false, metricType=FLOAT, metricName2=cpu_aidle, units=%, slope=both, tmax=3800, dmax=0, extraValues={TITLE="CPU aidle"},DESC="Percent of time since boot idle CPU"},GROUP="cpu"}}}
 GangliaMetadataMessage{ recordType=METADATA, hostName=bigdata08, metricName=cpu_wio, spoof=false, metricType=FLOAT, metricName2=cpu_wio, units=%, slope=both, tmax=90, dmax=0, extraValues={TITLE="CPU wio"},DESC="Percentage of time that the CPU or CPUs were idle during which the system had an outstanding disk I/O request"},GROUP="cpu"}}}
 GangliaMetadataMessage{ recordType=METADATA, hostName=bigdata08, metricName=cpu_intr, spoof=false, metricType=FLOAT, metricName2=cpu_intr, units=%, slope=both, tmax=90, dmax=0, extraValues={TITLE="CPU intr"},DESC="cpu_intr"},GROUP="cpu"}}}
 GangliaMetadataMessage{ recordType=METADATA, hostName=bigdata08, metricName=cpu_sintr, spoof=false, metricType=FLOAT, metricName2=cpu_sintr, units=%, slope=both, tmax=90, dmax=0, extraValues={TITLE="CPU sintr"},DESC="cpu_sintr"},GROUP="cpu"}}}
 GangliaMetadataMessage{ recordType=METADATA, hostName=bigdata08, metricName=load_one, spoof=false, metricType=FLOAT, metricName2=load_one, units= , slope=both, tmax=70, dmax=0, extraValues={TITLE="One Minute Load Average"},DESC="One minute load average"},GROUP="load"}}}
 GangliaMetadataMessage{ recordType=METADATA, hostName=bigdata08, metricName=load_five, spoof=false, metricType=FLOAT, metricName2=load_five, units= , slope=both, tmax=325, dmax=0, extraValues={TITLE="Five Minute Load Average"},DESC="Five minute load average"},GROUP="load"}}}
 GangliaMetadataMessage{ recordType=METADATA, hostName=bigdata08, metricName=load_fifteen, spoof=false, metricType=FLOAT, metricName2=load_fifteen, units= , slope=both, tmax=950, dmax=0, extraValues={TITLE="Fifteen Minute Load Average"},DESC="Fifteen minute load average"},GROUP="load"}}}
 GangliaMetadataMessage{ recordType=METADATA, hostName=bigdata08, metricName=proc_run, spoof=false, metricType=UINT32, metricName2=proc_run, units= , slope=both, tmax=950, dmax=0, extraValues={TITLE="Total Running Processes"},DESC="Total number of running processes"},GROUP="process"}}}
 GangliaMetadataMessage{ recordType=METADATA, hostName=bigdata08, metricName=proc_total, spoof=false, metricType=UINT32, metricName2=proc_total, units= , slope=both, tmax=950, dmax=0, extraValues={TITLE="Total Processes"},DESC="Total number of processes"},GROUP="process"}}}
 GangliaMetadataMessage{ recordType=METADATA, hostName=bigdata08, metricName=mem_free, spoof=false, metricType=FLOAT, metricName2=mem_free, units=KB, slope=both, tmax=180, dmax=0, extraValues={TITLE="Free Memory"},DESC="Amount of available memory"},GROUP="memory"}}}
 GangliaMetadataMessage{ recordType=METADATA, hostName=bigdata08, metricName=mem_shared, spoof=false, metricType=FLOAT, metricName2=mem_shared, units=KB, slope=both, tmax=180, dmax=0, extraValues={TITLE="Shared Memory"},DESC="Amount of shared memory"},GROUP="memory"}}}
 GangliaMetadataMessage{ recordType=METADATA, hostName=bigdata08, metricName=mem_buffers, spoof=false, metricType=FLOAT, metricName2=mem_buffers, units=KB, slope=both, tmax=180, dmax=0, extraValues={TITLE="Memory Buffers"},DESC="Amount of buffered memory"},GROUP="memory"}}}
 GangliaMetadataMessage{ recordType=METADATA, hostName=bigdata08, metricName=mem_cached, spoof=false, metricType=FLOAT, metricName2=mem_cached, units=KB, slope=both, tmax=180, dmax=0, extraValues={TITLE="Cached Memory"},DESC="Amount of cached memory"},GROUP="memory"}}}
 GangliaMetadataMessage{ recordType=METADATA, hostName=bigdata08, metricName=swap_free, spoof=false, metricType=FLOAT, metricName2=swap_free, units=KB, slope=both, tmax=180, dmax=0, extraValues={TITLE="Free Swap Space"},DESC="Amount of available swap memory"},GROUP="memory"}}}
 GangliaMetadataMessage{ recordType=METADATA, hostName=bigdata08, metricName=bytes_out, spoof=false, metricType=FLOAT, metricName2=bytes_out, units=bytes/sec, slope=both, tmax=300, dmax=0, extraValues={TITLE="Bytes Sent"},DESC="Number of bytes out per second"},GROUP="network"}}}
 GangliaMetadataMessage{ recordType=METADATA, hostName=bigdata08, metricName=bytes_in, spoof=false, metricType=FLOAT, metricName2=bytes_in, units=bytes/sec, slope=both, tmax=300, dmax=0, extraValues={TITLE="Bytes Received"},DESC="Number of bytes in per second"},GROUP="network"}}}
 GangliaMetadataMessage{ recordType=METADATA, hostName=bigdata08, metricName=pkts_in, spoof=false, metricType=FLOAT, metricName2=pkts_in, units=packets/sec, slope=both, tmax=300, dmax=0, extraValues={TITLE="Packets Received"},DESC="Packets in per second"},GROUP="network"}}}
 GangliaMetadataMessage{ recordType=METADATA, hostName=bigdata08, metricName=pkts_out, spoof=false, metricType=FLOAT, metricName2=pkts_out, units=packets/sec, slope=both, tmax=300, dmax=0, extraValues={TITLE="Packets Sent"},DESC="Packets out per second"},GROUP="network"}}}
 GangliaMetadataMessage{ recordType=METADATA, hostName=bigdata08, metricName=disk_total, spoof=false, metricType=DOUBLE, metricName2=disk_total, units=GB, slope=both, tmax=1200, dmax=0, extraValues={TITLE="Total Disk Space"},DESC="Total available disk space"},GROUP="disk"}}}
 GangliaMetadataMessage{ recordType=METADATA, hostName=bigdata08, metricName=disk_free, spoof=false, metricType=DOUBLE, metricName2=disk_free, units=GB, slope=both, tmax=180, dmax=0, extraValues={TITLE="Disk Space Available"},DESC="Total free disk space"},GROUP="disk"}}}
 GangliaMetadataMessage{ recordType=METADATA, hostName=bigdata08, metricName=part_max_used, spoof=false, metricType=FLOAT, metricName2=part_max_used, units=%, slope=both, tmax=180, dmax=0, extraValues={TITLE="Maximum Disk Space Used"},DESC="Maximum percent used for all partitions"},GROUP="disk"}}}
 

TODO This is missing declarations for the following metrics (I am not observing those metrics under Ubuntu). While it might be difficult to get at the mtu for some platforms, it is quite odd that sys_clock is not being reported.

 mtu             Network maximum transmission unit (module sys_module)
 sys_clock       Time as reported by the system clock (module sys_module)
 

Field Summary

Fields

Modifier and Type	Field and Description
protected int	heartbeatInterval The heartbeat interval in seconds -or- ZERO (0) if we will not be sending out the ganglia host heartbeat.

Fields inherited from class com.bigdata.ganglia.AbstractMetrics

dmax, emptyMap, hostName, slope, tmax

Fields inherited from interface com.bigdata.ganglia.IGangliaAttributes

ATTR_DESC, ATTR_GROUP, ATTR_TITLE, GROUP_CORE, GROUP_CPU, GROUP_DISK, GROUP_LOAD, GROUP_MEMORY, GROUP_NETWORK, GROUP_PROCESS, GROUP_SYSTEM

Constructor Summary

Constructors

Constructor and Description
GangliaCoreMetricDecls(String hostName, GangliaSlopeEnum slope, int tmax, int dmax, int heartbeatInterval) Note: Some metrics have non-default values of slope, tmax, and dmax.

Method Summary

Methods

Modifier and Type	Method and Description
IGangliaMetadataMessage	boottime()
IGangliaMetadataMessage	bytes_in()
IGangliaMetadataMessage	bytes_out()
IGangliaMetadataMessage	cpu_aidle()
IGangliaMetadataMessage	cpu_idle()
IGangliaMetadataMessage	cpu_intr()
IGangliaMetadataMessage	cpu_nice()
IGangliaMetadataMessage	cpu_num()
IGangliaMetadataMessage	cpu_sintr()
IGangliaMetadataMessage	cpu_speed()
IGangliaMetadataMessage	cpu_system()
IGangliaMetadataMessage	cpu_user()
IGangliaMetadataMessage	cpu_wio()
void	declare(GangliaState gangliaState) Declare some well known OS/platform level metrics (optional step).
IGangliaMetadataMessage	disk_free()
IGangliaMetadataMessage	disk_total()
IGangliaMetadataMessage	gexec()
IGangliaMetadataMessage	heartbeat()
static IGangliaMetadataMessage	heartbeat(String hostName, int heartbeatInterval)
IGangliaMetadataMessage	load_fifteen()
IGangliaMetadataMessage	load_five()
IGangliaMetadataMessage	load_one()
IGangliaMetadataMessage	location()
IGangliaMetadataMessage	machine_type()
IGangliaMetadataMessage	mem_buffers()
IGangliaMetadataMessage	mem_cached()
IGangliaMetadataMessage	mem_free()
IGangliaMetadataMessage	mem_shared()
IGangliaMetadataMessage	mem_total()
IGangliaMetadataMessage	os_name()
IGangliaMetadataMessage	os_release()
IGangliaMetadataMessage	part_max_used()
IGangliaMetadataMessage	pkts_in()
IGangliaMetadataMessage	pkts_out()
IGangliaMetadataMessage	proc_run()
IGangliaMetadataMessage	proc_total()
IGangliaMetadataMessage	swap_free()
IGangliaMetadataMessage	swap_total()

Methods inherited from class com.bigdata.ganglia.AbstractMetrics

getMap

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

heartbeatInterval

protected final int heartbeatInterval

The heartbeat interval in seconds -or- ZERO (0) if we will not be sending out the ganglia host heartbeat.

See Also:

IGangliaDefaults.HEARTBEAT_INTERVAL

Constructor Detail

GangliaCoreMetricDecls

public GangliaCoreMetricDecls(String hostName,
                      GangliaSlopeEnum slope,
                      int tmax,
                      int dmax,
                      int heartbeatInterval)

Note: Some metrics have non-default values of slope, tmax, and dmax. For example, load_fifteen(). The constructor values will not override the values for such metrics.

Parameters:

hostName - The name of this host.

slope - The default value to use in the declarations.

tmax - The value of tmax to use in the declarations.

dmax - The value of dmax to use in the declarations.

heartbeatInterval - The heartbeat interval in seconds -or- ZERO (0) if we will not be sending out the ganglia host heartbeat.

Method Detail

heartbeat

public static final IGangliaMetadataMessage heartbeat(String hostName,
                                int heartbeatInterval)

heartbeat

public final IGangliaMetadataMessage heartbeat()

gexec

public final IGangliaMetadataMessage gexec()

mem_free

public final IGangliaMetadataMessage mem_free()

mem_shared

public final IGangliaMetadataMessage mem_shared()

mem_buffers

public final IGangliaMetadataMessage mem_buffers()

mem_cached

public final IGangliaMetadataMessage mem_cached()

mem_total

public final IGangliaMetadataMessage mem_total()

swap_free

public final IGangliaMetadataMessage swap_free()

swap_total

public final IGangliaMetadataMessage swap_total()

load_one

public final IGangliaMetadataMessage load_one()

load_five

public final IGangliaMetadataMessage load_five()

load_fifteen

public final IGangliaMetadataMessage load_fifteen()

proc_run

public final IGangliaMetadataMessage proc_run()

proc_total

public final IGangliaMetadataMessage proc_total()

cpu_user

public final IGangliaMetadataMessage cpu_user()

cpu_system

public final IGangliaMetadataMessage cpu_system()

cpu_idle

public final IGangliaMetadataMessage cpu_idle()

cpu_nice

public final IGangliaMetadataMessage cpu_nice()

cpu_aidle

public final IGangliaMetadataMessage cpu_aidle()

cpu_wio

public final IGangliaMetadataMessage cpu_wio()

cpu_intr

public final IGangliaMetadataMessage cpu_intr()

cpu_sintr

public final IGangliaMetadataMessage cpu_sintr()

bytes_out

public final IGangliaMetadataMessage bytes_out()

bytes_in

public final IGangliaMetadataMessage bytes_in()

pkts_in

public final IGangliaMetadataMessage pkts_in()

pkts_out

public final IGangliaMetadataMessage pkts_out()

disk_total

public final IGangliaMetadataMessage disk_total()

disk_free

public final IGangliaMetadataMessage disk_free()

part_max_used

public final IGangliaMetadataMessage part_max_used()

boottime

public final IGangliaMetadataMessage boottime()

machine_type

public final IGangliaMetadataMessage machine_type()

os_name

public final IGangliaMetadataMessage os_name()

os_release

public final IGangliaMetadataMessage os_release()

cpu_num

public final IGangliaMetadataMessage cpu_num()

cpu_speed

public final IGangliaMetadataMessage cpu_speed()

location

public final IGangliaMetadataMessage location()

declare

public void declare(GangliaState gangliaState)

Declare some well known OS/platform level metrics (optional step).

Parameters:

gangliaState - The metrics will be declared to this state object. FIXME Why never invoked?