AbstractGangliaSink (Apache Hadoop Common 3.4.1.100-eep-941 API)

java.lang.Object
- org.apache.hadoop.metrics2.sink.ganglia.AbstractGangliaSink

All Implemented Interfaces:

MetricsPlugin, MetricsSink

Direct Known Subclasses:

GangliaSink30
```
public abstract class AbstractGangliaSink
extends java.lang.Object
implements MetricsSink
```
This the base class for Ganglia sink classes using metrics2. Lot of the code has been derived from org.apache.hadoop.metrics.ganglia.GangliaContext. As per the documentation, sink implementations doesn't have to worry about thread safety. Hence the code wasn't written for thread safety and should be modified in case the above assumption changes in the future.

Nested Class Summary

Nested Classes
Modifier and Type	Class	Description
`static class`	`AbstractGangliaSink.GangliaConfType`	define enum for various type of conf
`static class`	`AbstractGangliaSink.GangliaSlope`	ganglia slope values which equal the ordinal

Field Summary

Fields
Modifier and Type	Field	Description
`static int`	`BUFFER_SIZE`
`static int`	`DEFAULT_DMAX`
`static boolean`	`DEFAULT_MULTICAST_ENABLED`
`static int`	`DEFAULT_MULTICAST_TTL`
`static int`	`DEFAULT_PORT`
`static AbstractGangliaSink.GangliaSlope`	`DEFAULT_SLOPE`
`static int`	`DEFAULT_TMAX`
`static java.lang.String`	`DEFAULT_UNITS`
`static java.lang.String`	`EQUAL`
`protected org.apache.hadoop.metrics2.sink.ganglia.GangliaMetricVisitor`	`gangliaMetricVisitor`	Used for visiting Metrics
`org.slf4j.Logger`	`LOG`
`static java.lang.String`	`MULTICAST_ENABLED_PROPERTY`
`static java.lang.String`	`MULTICAST_TTL_PROPERTY`
`static java.lang.String`	`SERVERS_PROPERTY`
`static boolean`	`SUPPORT_SPARSE_METRICS_DEFAULT`
`static java.lang.String`	`SUPPORT_SPARSE_METRICS_PROPERTY`

Constructor Summary

Constructors
Constructor Description

AbstractGangliaSink()

Constructors
Constructor	Description
`AbstractGangliaSink()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`protected void`	`emitToGangliaHosts()`	Sends Ganglia Metrics to the configured hosts
`void`	`flush()`	Flush any buffered metrics
`protected org.apache.hadoop.metrics2.sink.ganglia.GangliaConf`	`getGangliaConfForMetric(java.lang.String metricName)`	Lookup GangliaConf from cache.
`protected java.lang.String`	`getHostName()`
`java.util.List<? extends java.net.SocketAddress>`	`getMetricsServers()`
`void`	`init(org.apache.commons.configuration2.SubsetConfiguration conf)`	Initialize the plugin
`protected boolean`	`isSupportSparseMetrics()`
`protected void`	`xdr_int(int i)`	Puts an integer into the buffer as 4 bytes, big-endian.
`protected void`	`xdr_string(java.lang.String s)`	Puts a string into the buffer by first writing the size of the string as an int, followed by the bytes of the string, padded if necessary to a multiple of 4.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.hadoop.metrics2.MetricsSink
putMetrics

- Field Detail
  - LOG
```
public final org.slf4j.Logger LOG
```
  - DEFAULT_UNITS
```
public static final java.lang.String DEFAULT_UNITS
```
    See Also:
    
    Constant Field Values
  - DEFAULT_TMAX
```
public static final int DEFAULT_TMAX
```
    See Also:
    
    Constant Field Values
  - DEFAULT_DMAX
```
public static final int DEFAULT_DMAX
```
    See Also:
    
    Constant Field Values
  - DEFAULT_SLOPE
```
public static final AbstractGangliaSink.GangliaSlope DEFAULT_SLOPE
```
  - DEFAULT_PORT
```
public static final int DEFAULT_PORT
```
    See Also:
    
    Constant Field Values
  - DEFAULT_MULTICAST_ENABLED
```
public static final boolean DEFAULT_MULTICAST_ENABLED
```
    See Also:
    
    Constant Field Values
  - DEFAULT_MULTICAST_TTL
```
public static final int DEFAULT_MULTICAST_TTL
```
    See Also:
    
    Constant Field Values
  - SERVERS_PROPERTY
```
public static final java.lang.String SERVERS_PROPERTY
```
    See Also:
    
    Constant Field Values
  - MULTICAST_ENABLED_PROPERTY
```
public static final java.lang.String MULTICAST_ENABLED_PROPERTY
```
    See Also:
    
    Constant Field Values
  - MULTICAST_TTL_PROPERTY
```
public static final java.lang.String MULTICAST_TTL_PROPERTY
```
    See Also:
    
    Constant Field Values
  - BUFFER_SIZE
```
public static final int BUFFER_SIZE
```
    See Also:
    
    Constant Field Values
  - SUPPORT_SPARSE_METRICS_PROPERTY
```
public static final java.lang.String SUPPORT_SPARSE_METRICS_PROPERTY
```
    See Also:
    
    Constant Field Values
  - SUPPORT_SPARSE_METRICS_DEFAULT
```
public static final boolean SUPPORT_SPARSE_METRICS_DEFAULT
```
    See Also:
    
    Constant Field Values
  - EQUAL
```
public static final java.lang.String EQUAL
```
    See Also:
    
    Constant Field Values
  - gangliaMetricVisitor
```
protected final org.apache.hadoop.metrics2.sink.ganglia.GangliaMetricVisitor gangliaMetricVisitor
```
    Used for visiting Metrics
- Constructor Detail
  - AbstractGangliaSink
```
public AbstractGangliaSink()
```
- Method Detail
  - getMetricsServers
```
public java.util.List<? extends java.net.SocketAddress> getMetricsServers()
```
  - init
```
public void init(org.apache.commons.configuration2.SubsetConfiguration conf)
```
    Description copied from interface: MetricsPlugin
    
    Initialize the plugin
    
    Specified by:
    
    init in interface MetricsPlugin
    
    Parameters:
    
    conf - the configuration object for the plugin
  - flush
```
public void flush()
```
    Description copied from interface: MetricsSink
    
    Flush any buffered metrics
    
    Specified by:
    
    flush in interface MetricsSink
  - getGangliaConfForMetric
```
protected org.apache.hadoop.metrics2.sink.ganglia.GangliaConf getGangliaConfForMetric(java.lang.String metricName)
```
    Lookup GangliaConf from cache. If not found, return default values
    
    Parameters:
    
    metricName - metricName.
    
    Returns:
    
    looked up GangliaConf
  - getHostName
```
protected java.lang.String getHostName()
```
    Returns:
    
    the hostName
  - xdr_string
```
protected void xdr_string(java.lang.String s)
```
    Puts a string into the buffer by first writing the size of the string as an int, followed by the bytes of the string, padded if necessary to a multiple of 4.
    
    Parameters:
    
    s - the string to be written to buffer at offset location
  - xdr_int
```
protected void xdr_int(int i)
```
    Puts an integer into the buffer as 4 bytes, big-endian.
    
    Parameters:
    
    i - i.
  - emitToGangliaHosts
```
protected void emitToGangliaHosts()
                           throws java.io.IOException
```
    Sends Ganglia Metrics to the configured hosts
    
    Throws:
    
    java.io.IOException - raised on errors performing I/O.
  - isSupportSparseMetrics
```
protected boolean isSupportSparseMetrics()
```
    Returns:
    
    whether sparse metrics are supported

Class AbstractGangliaSink

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface org.apache.hadoop.metrics2.MetricsSink

Field Detail

LOG

DEFAULT_UNITS

DEFAULT_TMAX

DEFAULT_DMAX

DEFAULT_SLOPE

DEFAULT_PORT

DEFAULT_MULTICAST_ENABLED

DEFAULT_MULTICAST_TTL

SERVERS_PROPERTY

MULTICAST_ENABLED_PROPERTY

MULTICAST_TTL_PROPERTY

BUFFER_SIZE

SUPPORT_SPARSE_METRICS_PROPERTY

SUPPORT_SPARSE_METRICS_DEFAULT

EQUAL

gangliaMetricVisitor

Constructor Detail

AbstractGangliaSink

Method Detail

getMetricsServers

init

flush

getGangliaConfForMetric

getHostName

xdr_string

xdr_int

emitToGangliaHosts

isSupportSparseMetrics