com.googlecode.jmxtrans.model.output

Class GangliaWriter

java.lang.Object

com.googlecode.jmxtrans.model.output.BaseOutputWriter

com.googlecode.jmxtrans.model.output.GangliaWriter

All Implemented Interfaces:

OutputWriter, OutputWriterFactory, java.lang.AutoCloseable

public class GangliaWriter
extends BaseOutputWriter

OutputWriter for Ganglia.

Author:

Julien Nicoulaud , jon

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GangliaWriter.Builder

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ADDRESSING_MODE
static info.ganglia.gmetric4j.gmetric.GMetric.UDPAddressingMode	DEFAULT_ADDRESSING_MODE
static int	DEFAULT_DMAX
static java.lang.String	DEFAULT_GROUP_NAME
static int	DEFAULT_PORT
static info.ganglia.gmetric4j.gmetric.GMetricSlope	DEFAULT_SLOPE
static int	DEFAULT_TMAX
static int	DEFAULT_TTL
static java.lang.String	DEFAULT_UNITS
static boolean	DEFAULT_V31
static java.lang.String	DMAX
static java.lang.String	GROUP_NAME
static java.lang.String	SLOPE
static java.lang.String	SPOOF_NAME
static java.lang.String	TMAX
static java.lang.String	TTL
static java.lang.String	UNITS
static java.lang.String	V31

Fields inherited from class com.googlecode.jmxtrans.model.output.BaseOutputWriter

BINARY_PATH, BOOLEAN_AS_NUMBER, DEBUG, HOST, OUTPUT_FILE, PORT, TEMPLATE_FILE, TYPE_NAMES

Constructor Summary

Constructors

Constructor and Description

GangliaWriter(com.google.common.collect.ImmutableList<java.lang.String> typeNames, boolean booleanAsNumber, java.lang.Boolean debugEnabled, java.lang.String host, java.lang.Integer port, java.lang.String addressingMode, java.lang.Integer ttl, java.lang.Boolean v31, java.lang.String units, java.lang.String slope, java.lang.Integer tmax, java.lang.Integer dmax, java.lang.String groupName, java.util.Map<java.lang.String,java.lang.Object> settings)

Method Summary

Modifier and Type	Method and Description
static GangliaWriter.Builder	builder()
java.lang.String	getAddressingMode()
int	getDmax()
java.lang.String	getGroupName()
java.lang.String	getHost()
int	getPort()
info.ganglia.gmetric4j.gmetric.GMetricSlope	getSlope()
static java.lang.String	getSpoofedHostName(java.lang.String host, java.lang.String alias) Determines the spoofed host name to be used when emitting metrics to a gmond process.
int	getTmax()
int	getTtl()
java.lang.String	getUnits()
void	internalWrite(Server server, Query query, com.google.common.collect.ImmutableList<Result> results) Send query result values to Ganglia.
boolean	isV31()
void	validateSetup(Server server, Query query) Parse and validate settings.

Methods inherited from class com.googlecode.jmxtrans.model.output.BaseOutputWriter

close, create, doWrite, firstNonNull, getConcatedTypeNameValues, getSettings, getTypeNames, isDebugEnabled, start, toString

Methods inherited from class java.lang.Object

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

Field Detail

ADDRESSING_MODE

public static final java.lang.String ADDRESSING_MODE

See Also:

Constant Field Values

TTL

public static final java.lang.String TTL

See Also:

Constant Field Values

V31

public static final java.lang.String V31

See Also:

Constant Field Values

UNITS

public static final java.lang.String UNITS

See Also:

Constant Field Values

SLOPE

public static final java.lang.String SLOPE

See Also:

Constant Field Values

TMAX

public static final java.lang.String TMAX

See Also:

Constant Field Values

DMAX

public static final java.lang.String DMAX

See Also:

Constant Field Values

GROUP_NAME

public static final java.lang.String GROUP_NAME

See Also:

Constant Field Values

SPOOF_NAME

public static final java.lang.String SPOOF_NAME

See Also:

Constant Field Values

DEFAULT_PORT

public static final int DEFAULT_PORT

See Also:

Constant Field Values

DEFAULT_ADDRESSING_MODE

public static final info.ganglia.gmetric4j.gmetric.GMetric.UDPAddressingMode DEFAULT_ADDRESSING_MODE

DEFAULT_TTL

public static final int DEFAULT_TTL

See Also:

Constant Field Values

DEFAULT_V31

public static final boolean DEFAULT_V31

See Also:

Constant Field Values

DEFAULT_UNITS

public static final java.lang.String DEFAULT_UNITS

See Also:

Constant Field Values

DEFAULT_SLOPE

public static final info.ganglia.gmetric4j.gmetric.GMetricSlope DEFAULT_SLOPE

DEFAULT_DMAX

public static final int DEFAULT_DMAX

See Also:

Constant Field Values

DEFAULT_TMAX

public static final int DEFAULT_TMAX

See Also:

Constant Field Values

DEFAULT_GROUP_NAME

public static final java.lang.String DEFAULT_GROUP_NAME

See Also:

Constant Field Values

Constructor Detail

GangliaWriter

public GangliaWriter(com.google.common.collect.ImmutableList<java.lang.String> typeNames,
                     boolean booleanAsNumber,
                     java.lang.Boolean debugEnabled,
                     java.lang.String host,
                     java.lang.Integer port,
                     java.lang.String addressingMode,
                     java.lang.Integer ttl,
                     java.lang.Boolean v31,
                     java.lang.String units,
                     java.lang.String slope,
                     java.lang.Integer tmax,
                     java.lang.Integer dmax,
                     java.lang.String groupName,
                     java.util.Map<java.lang.String,java.lang.Object> settings)

Method Detail

validateSetup

public void validateSetup(Server server,
                          Query query)
                   throws ValidationException

Parse and validate settings.

Throws:

ValidationException

internalWrite

public void internalWrite(Server server,
                          Query query,
                          com.google.common.collect.ImmutableList<Result> results)
                   throws java.lang.Exception

Send query result values to Ganglia.

Specified by:

internalWrite in class BaseOutputWriter

Throws:

java.lang.Exception

getSpoofedHostName

public static java.lang.String getSpoofedHostName(java.lang.String host,
                                                  java.lang.String alias)

Determines the spoofed host name to be used when emitting metrics to a gmond process. Spoofed host names are of the form IP:hostname.

Parameters:

host - the host of the gmond (ganglia monitor) to which we are connecting, not null

alias - the custom alias supplied, may be null

Returns:

the host name to use when emitting metrics, in the form of IP:hostname

getHost

public java.lang.String getHost()

getPort

public int getPort()

getAddressingMode

public java.lang.String getAddressingMode()

getTtl

public int getTtl()

isV31

public boolean isV31()

getUnits

public java.lang.String getUnits()

getSlope

public info.ganglia.gmetric4j.gmetric.GMetricSlope getSlope()

getTmax

public int getTmax()

getDmax

public int getDmax()

getGroupName

public java.lang.String getGroupName()

builder

public static GangliaWriter.Builder builder()