net.logstash.logback.encoder

Class LogstashTcpEncoder

java.lang.Object

ch.qos.logback.core.spi.ContextAwareBase

ch.qos.logback.core.encoder.EncoderBase<ch.qos.logback.classic.spi.ILoggingEvent>

net.logstash.logback.encoder.LogstashEncoder

net.logstash.logback.encoder.LogstashTcpEncoder

All Implemented Interfaces:

ch.qos.logback.core.encoder.Encoder<ch.qos.logback.classic.spi.ILoggingEvent>, ch.qos.logback.core.spi.ContextAware, ch.qos.logback.core.spi.LifeCycle

public class LogstashTcpEncoder
extends LogstashEncoder

Extend LogstashEncoder adding encoding support and the new line termination.
The new parameter name are:

<ENCODING/> Define the used encoding as defined in Charset. The default value is UTF-8

<NEWLINE/> Define the new line. Any defined character is used as new line terminator.
The set of pre-defined values are:
UNIX \n character (default).
NULL no new line.
SYSTEM operating system new line.
WINDOWS the \r\n combination

Since:

11 Jun 2014 (creation date)

Author:

Mirko Bernardoni

Field Summary

Fields inherited from class ch.qos.logback.core.encoder.EncoderBase

outputStream, started

Fields inherited from class ch.qos.logback.core.spi.ContextAwareBase

context

Constructor Summary

Constructors

Constructor and Description
LogstashTcpEncoder()

Method Summary

Methods

Modifier and Type	Method and Description
void	close()
void	doEncode(ch.qos.logback.classic.spi.ILoggingEvent event)
String	getEncoding()
String	getNewLine()
void	setEncoding(String encoding) Define the encoding used for sending the logs
void	setNewLine(String newLine) Define the new line.

Methods inherited from class net.logstash.logback.encoder.LogstashEncoder

addExcludeMdcKeyName, addIncludeMdcKeyName, getCustomFields, getExcludeMdcKeyNames, getFieldNames, getFormatter, getIncludeMdcKeyNames, getJsonFactoryDecorator, getJsonGeneratorDecorator, getShortenedLoggerNameLength, getThrowableConverter, getTimeZone, isEnableContextMap, isImmediateFlush, isIncludeCallerInfo, isIncludeContext, isIncludeMdc, setCustomFields, setEnableContextMap, setExcludeMdcKeyNames, setFieldNames, setImmediateFlush, setIncludeCallerInfo, setIncludeContext, setIncludeMdc, setIncludeMdcKeyNames, setJsonFactoryDecorator, setJsonGeneratorDecorator, setShortenedLoggerNameLength, setThrowableConverter, setTimeZone, start, stop

Methods inherited from class ch.qos.logback.core.encoder.EncoderBase

init, isStarted

Methods inherited from class ch.qos.logback.core.spi.ContextAwareBase

addError, addError, addInfo, addInfo, addStatus, addWarn, addWarn, getContext, getDeclaredOrigin, getStatusManager, setContext

Methods inherited from class java.lang.Object

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

Methods inherited from interface ch.qos.logback.core.spi.ContextAware

addError, addError, addInfo, addInfo, addStatus, addWarn, addWarn, getContext, setContext

Constructor Detail

LogstashTcpEncoder

public LogstashTcpEncoder()

Method Detail

doEncode

public void doEncode(ch.qos.logback.classic.spi.ILoggingEvent event)
              throws IOException

Specified by:

doEncode in interface ch.qos.logback.core.encoder.Encoder<ch.qos.logback.classic.spi.ILoggingEvent>

Overrides:

doEncode in class LogstashEncoder

Throws:

IOException

close

public void close()
           throws IOException

Specified by:

close in interface ch.qos.logback.core.encoder.Encoder<ch.qos.logback.classic.spi.ILoggingEvent>

Overrides:

close in class LogstashEncoder

Throws:

IOException

setEncoding

public void setEncoding(String encoding)

Define the encoding used for sending the logs

Parameters:

encoding - the encoding to set

getEncoding

public String getEncoding()

Returns:

the encoding

setNewLine

public void setNewLine(String newLine)

Define the new line.
NULL no new line.
SYSTEM operating system new line.
UNIX is the \n combination (default).
WINDOWS is \r\n combination

Parameters:

newLine - the newLine to set

getNewLine

public String getNewLine()

Returns:

the newLine