com.googlecode.jmxtrans.model.output

Class RRDToolWriter

java.lang.Object

com.googlecode.jmxtrans.model.output.BaseOutputWriter

com.googlecode.jmxtrans.model.output.RRDToolWriter

All Implemented Interfaces:

OutputWriter, OutputWriterFactory, java.lang.AutoCloseable

public class RRDToolWriter
extends BaseOutputWriter

This takes a JRobin template.xml file and then creates the database if it doesn't already exist. It will then write the contents of the Query (the Results) to the database. This method exec's out to use the command line version of rrdtool. You need to specify the path to the directory where the binary rrdtool lives.

Author:

jon

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RRDToolWriter.Builder

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	GENERATE

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
RRDToolWriter(com.google.common.collect.ImmutableList<java.lang.String> typeNames, boolean booleanAsNumber, java.lang.Boolean debugEnabled, java.lang.String outputFile, java.lang.String templateFile, java.lang.String binaryPath, java.lang.Boolean generate, java.util.Map<java.lang.String,java.lang.Object> settings)

Method Summary

Modifier and Type	Method and Description
static RRDToolWriter.Builder	builder()
java.lang.String	getBinaryPath()
protected org.jrobin.core.RrdDef	getDatabaseTemplateSpec() If the database file doesn't exist, it'll get created, otherwise, it'll be returned in r/w mode.
java.lang.String	getDataSourceName(java.lang.String typeName, java.lang.String attributeName, java.lang.String entry) rrd datasources must be less than 21 characters in length, so work to make it shorter.
java.lang.String	getOutputFile()
java.lang.String	getTemplateFile()
void	internalWrite(Server server, Query query, com.google.common.collect.ImmutableList<Result> results)
protected void	rrdToolCreateDatabase(org.jrobin.core.RrdDef def) Calls out to the rrdtool binary with the 'create' command.
protected void	rrdToolUpdate(java.lang.String template, java.lang.String data) Executes the rrdtool update command.
void	validateSetup(Server server, Query query)

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

GENERATE

public static final java.lang.String GENERATE

See Also:

Constant Field Values

Constructor Detail

RRDToolWriter

public RRDToolWriter(com.google.common.collect.ImmutableList<java.lang.String> typeNames,
                     boolean booleanAsNumber,
                     java.lang.Boolean debugEnabled,
                     java.lang.String outputFile,
                     java.lang.String templateFile,
                     java.lang.String binaryPath,
                     java.lang.Boolean generate,
                     java.util.Map<java.lang.String,java.lang.Object> settings)

Method Detail

validateSetup

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

Throws:

ValidationException

getDataSourceName

public java.lang.String getDataSourceName(java.lang.String typeName,
                                          java.lang.String attributeName,
                                          java.lang.String entry)

rrd datasources must be less than 21 characters in length, so work to make it shorter. Not ideal at all, but works fairly well it seems.

internalWrite

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

Specified by:

internalWrite in class BaseOutputWriter

Throws:

java.lang.Exception

rrdToolUpdate

protected void rrdToolUpdate(java.lang.String template,
                             java.lang.String data)
                      throws java.lang.Exception

Executes the rrdtool update command.

Throws:

java.lang.Exception

getDatabaseTemplateSpec

protected org.jrobin.core.RrdDef getDatabaseTemplateSpec()
                                                  throws java.lang.Exception

If the database file doesn't exist, it'll get created, otherwise, it'll be returned in r/w mode.

Throws:

java.lang.Exception

rrdToolCreateDatabase

protected void rrdToolCreateDatabase(org.jrobin.core.RrdDef def)
                              throws java.lang.Exception

Calls out to the rrdtool binary with the 'create' command.

Throws:

java.lang.Exception

getOutputFile

public java.lang.String getOutputFile()

getTemplateFile

public java.lang.String getTemplateFile()

getBinaryPath

public java.lang.String getBinaryPath()

builder

public static RRDToolWriter.Builder builder()