info.ganglia.gmetric4j.gmetric

Class GMetric

java.lang.Object

info.ganglia.gmetric4j.gmetric.GMetric

All Implemented Interfaces:

Closeable, AutoCloseable

public class GMetric
extends Object
implements Closeable

Implements the Ganglia gmetric command in java

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GMetric.UDPAddressingMode

Constructor Summary

Constructors

Constructor and Description
GMetric(String group, int port, GMetric.UDPAddressingMode mode, int ttl) Constructs a GMetric
GMetric(String group, int port, GMetric.UDPAddressingMode mode, int ttl, boolean ganglia311) Constructs a GMetric
GMetric(String group, int port, GMetric.UDPAddressingMode mode, int ttl, boolean ganglia311, UUID uuid) Constructs a GMetric
GMetric(String group, int port, GMetric.UDPAddressingMode mode, int ttl, boolean ganglia311, UUID uuid, String spoof) Constructs a GMetric

Method Summary

Modifier and Type	Method and Description
void	announce(String name, double value, String group) Announces a metric
void	announce(String name, float value, String group) Announces a metric
void	announce(String name, int value, String group) Announces a metric
void	announce(String name, long value, String group) Announces a metric
void	announce(String name, String value, GMetricType type, String units, GMetricSlope slope, int tmax, int dmax, String group) The Ganglia Metric Client (gmetric) announces a metric
void	close() Closes the underlying protocol.
protected void	finalize()
static void	main(String[] args) Main method that sends a test metric

Methods inherited from class java.lang.Object

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

Constructor Detail

GMetric

public GMetric(String group,
               int port,
               GMetric.UDPAddressingMode mode,
               int ttl)
        throws IOException

Constructs a GMetric

Parameters:

group - the host/group to send the event to

port - the port to send the event to

mode - the mode

ttl - time to live value

Throws:

IOException

GMetric

public GMetric(String group,
               int port,
               GMetric.UDPAddressingMode mode,
               int ttl,
               boolean ganglia311)
        throws IOException

Constructs a GMetric

Parameters:

group - the host/group to send the event to

port - the port to send the event to

mode - adressing mode to be used (UNICAST/MULTICAST)

ttl - time to live value

ganglia311 - protocol version true=v3.1, false=v3.0

Throws:

IOException

GMetric

public GMetric(String group,
               int port,
               GMetric.UDPAddressingMode mode,
               int ttl,
               boolean ganglia311,
               UUID uuid)
        throws IOException

Constructs a GMetric

Parameters:

group - the host/group to send the event to

port - the port to send the event to

mode - adressing mode to be used (UNICAST/MULTICAST)

ttl - time to live value

ganglia311 - protocol version true=v3.1, false=v3.0

uuid - uuid for the host

Throws:

IOException

GMetric

public GMetric(String group,
               int port,
               GMetric.UDPAddressingMode mode,
               int ttl,
               boolean ganglia311,
               UUID uuid,
               String spoof)
        throws IOException

Constructs a GMetric

Parameters:

group - the host/group to send the event to

port - the port to send the event to

mode - adressing mode to be used (UNICAST/MULTICAST)

ttl - time to live value

ganglia311 - protocol version true=v3.1, false=v3.0

uuid - uuid for the host

spoof - spoofing information IP:hostname

Throws:

IOException

Method Detail

announce

public void announce(String name,
                     String value,
                     GMetricType type,
                     String units,
                     GMetricSlope slope,
                     int tmax,
                     int dmax,
                     String group)
              throws GangliaException

The Ganglia Metric Client (gmetric) announces a metric

Parameters:

name - Name of the metric

value - Value of the metric

type - Type of the metric. Either string|int8|uint8|int16|uint16|int32|uint32|float|double

units - Unit of measure for the value

slope - Either zero|positive|negative|both

tmax - The maximum time in seconds between gmetric calls

dmax - The lifetime in seconds of this metric

group - Group Name of the metric

Throws:

Exception

GangliaException

announce

public void announce(String name,
                     int value,
                     String group)
              throws GangliaException

Announces a metric

Parameters:

name - Name of the metric

value - Value of the metric

group - Group Name of the metric

Throws:

ganglia.GangliaException

GangliaException

announce

public void announce(String name,
                     long value,
                     String group)
              throws GangliaException

Announces a metric

Parameters:

name - Name of the metric

value - Value of the metric

group - Group Name of the metric

Throws:

ganglia.GangliaException

GangliaException

announce

public void announce(String name,
                     float value,
                     String group)
              throws GangliaException

Announces a metric

Parameters:

name - Name of the metric

value - Value of the metric

group - Group Name of the metric

Throws:

ganglia.GangliaException

GangliaException

announce

public void announce(String name,
                     double value,
                     String group)
              throws GangliaException

Announces a metric

Parameters:

name - Name of the metric

value - Value of the metric

group - Group Name of the metric

Throws:

ganglia.GangliaException

GangliaException

close

public void close()
           throws IOException

Closes the underlying protocol.

Specified by:

close in interface Closeable

Specified by:

close in interface AutoCloseable

Throws:

IOException

finalize

protected void finalize()
                 throws Throwable

Overrides:

finalize in class Object

Throws:

Throwable

See Also:

Object.finalize()

main

public static void main(String[] args)
                 throws IOException

Main method that sends a test metric

Parameters:

args -

Throws:

IOException