com.googlecode.jmxtrans.model.output

Class NagiosWriter

java.lang.Object

com.googlecode.jmxtrans.model.output.BaseOutputWriter

com.googlecode.jmxtrans.model.output.NagiosWriter

All Implemented Interfaces:

OutputWriter, OutputWriterFactory, java.lang.AutoCloseable

public class NagiosWriter
extends BaseOutputWriter

Writes out data in Nagios format to a file, it should be used with Nagios external command file.

Author:

Denis "Thuck" Doria

Field Summary

Fields

Modifier and Type	Field and Description
protected static int	LOG_IO_BUFFER_SIZE_BYTES
protected static java.lang.String	LOG_PATTERN
protected ch.qos.logback.classic.Logger	logger
protected java.util.Map<java.lang.String,ch.qos.logback.classic.Logger>	loggers

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
NagiosWriter(com.google.common.collect.ImmutableList<java.lang.String> typeNames, boolean booleanAsNumber, java.lang.Boolean debugEnabled, java.util.List<java.lang.String> filters, java.util.List<java.lang.String> thresholds, java.lang.String nagiosHost, java.lang.String outputFile, java.lang.String prefix, java.lang.String suffix, java.util.Map<java.lang.String,java.lang.Object> settings)

Method Summary

Modifier and Type	Method and Description
void	checkFile(Query query) Creates the logging.
void	close()
com.google.common.collect.ImmutableList<java.lang.String>	getFilters()
java.lang.String	getNagiosHost()
java.lang.String	getOutputFile()
java.lang.String	getPrefix()
java.lang.String	getSuffix()
com.google.common.collect.ImmutableList<java.lang.String>	getThresholds()
protected ch.qos.logback.classic.Logger	initLogger(java.lang.String fileStr) Initializes the logger.
void	internalWrite(Server server, Query query, com.google.common.collect.ImmutableList<Result> results) The meat of the output.
protected java.lang.String	nagiosCheckValue(java.lang.String value, java.lang.String composeRange) Define if a value is in a critical, warning or ok state.
void	validateSetup(Server server, Query query) Initial log setup.
protected boolean	valueCheck(double value, java.lang.String simpleRange) Check if a value is inside of a range defined in the thresholds.

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

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

LOG_PATTERN

protected static final java.lang.String LOG_PATTERN

See Also:

Constant Field Values

LOG_IO_BUFFER_SIZE_BYTES

protected static final int LOG_IO_BUFFER_SIZE_BYTES

See Also:

Constant Field Values

loggers

protected final java.util.Map<java.lang.String,ch.qos.logback.classic.Logger> loggers

logger

protected ch.qos.logback.classic.Logger logger

Constructor Detail

NagiosWriter

public NagiosWriter(com.google.common.collect.ImmutableList<java.lang.String> typeNames,
                    boolean booleanAsNumber,
                    java.lang.Boolean debugEnabled,
                    java.util.List<java.lang.String> filters,
                    java.util.List<java.lang.String> thresholds,
                    java.lang.String nagiosHost,
                    java.lang.String outputFile,
                    java.lang.String prefix,
                    java.lang.String suffix,
                    java.util.Map<java.lang.String,java.lang.Object> settings)

Method Detail

validateSetup

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

Initial log setup.

Throws:

ValidationException

checkFile

public void checkFile(Query query)
               throws ValidationException

Creates the logging. Nagios doesn't start if the external command pipe exists, so we write to /dev/null until we have it available. From the official documentation:

The external command file is implemented as a named pipe (FIFO), which is created when Nagios starts and removed when it shuts down. If the file exists when Nagios starts, the Nagios process will terminate with an error message. http://nagios.sourceforge.net/docs/3_0/configmain.html#command_file

Throws:

ValidationException

internalWrite

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

The meat of the output. Nagios format..

Specified by:

internalWrite in class BaseOutputWriter

Throws:

java.lang.Exception

initLogger

protected ch.qos.logback.classic.Logger initLogger(java.lang.String fileStr)
                                            throws java.io.IOException

Initializes the logger. This is called when we need to create a new logger for the given file name.

Parameters:

fileStr -

Returns:

a new Logger instance for the given fileStr

Throws:

java.io.IOException

nagiosCheckValue

protected java.lang.String nagiosCheckValue(java.lang.String value,
                                            java.lang.String composeRange)

Define if a value is in a critical, warning or ok state.

valueCheck

protected boolean valueCheck(double value,
                             java.lang.String simpleRange)

Check if a value is inside of a range defined in the thresholds. This check is based on Nagios range definition. http://nagiosplug.sourceforge.net/developer-guidelines.html#THRESHOLDFORMAT

close

public void close()

Specified by:

close in interface OutputWriter

Specified by:

close in interface java.lang.AutoCloseable

Overrides:

close in class BaseOutputWriter

getFilters

public com.google.common.collect.ImmutableList<java.lang.String> getFilters()

getThresholds

public com.google.common.collect.ImmutableList<java.lang.String> getThresholds()

getNagiosHost

public java.lang.String getNagiosHost()

getOutputFile

public java.lang.String getOutputFile()

getPrefix

public java.lang.String getPrefix()

getSuffix

public java.lang.String getSuffix()