net.logstash.logback.appender

Class LogstashSocketAppender

java.lang.Object

ch.qos.logback.core.spi.ContextAwareBase

ch.qos.logback.core.AppenderBase<E>

ch.qos.logback.core.net.SyslogAppenderBase<ch.qos.logback.classic.spi.ILoggingEvent>

net.logstash.logback.appender.LogstashSocketAppender

All Implemented Interfaces:

ch.qos.logback.core.Appender<ch.qos.logback.classic.spi.ILoggingEvent>, ch.qos.logback.core.spi.ContextAware, ch.qos.logback.core.spi.FilterAttachable<ch.qos.logback.classic.spi.ILoggingEvent>, ch.qos.logback.core.spi.LifeCycle

public class LogstashSocketAppender
extends ch.qos.logback.core.net.SyslogAppenderBase<ch.qos.logback.classic.spi.ILoggingEvent>

Field Summary

Fields inherited from class ch.qos.logback.core.net.SyslogAppenderBase

suffixPattern

Fields inherited from class ch.qos.logback.core.AppenderBase

name, started

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

context

Constructor Summary

Constructors

Constructor and Description
LogstashSocketAppender()

Method Summary

Modifier and Type	Method and Description
void	addExcludeMdcKeyName(String excludedMdcKeyName)
void	addIncludeMdcKeyName(String includedMdcKeyName)
void	addListener(AppenderListener<ch.qos.logback.classic.spi.ILoggingEvent> listener)
void	addProvider(JsonProvider<ch.qos.logback.classic.spi.ILoggingEvent> provider)
protected void	append(ch.qos.logback.classic.spi.ILoggingEvent eventObject)
ch.qos.logback.core.Layout<ch.qos.logback.classic.spi.ILoggingEvent>	buildLayout()
ch.qos.logback.core.net.SyslogOutputStream	createOutputStream()
protected void	fireAppenderStarted()
protected void	fireAppenderStopped()
protected void	fireEventAppended(ch.qos.logback.classic.spi.ILoggingEvent event, long durationInNanos)
protected void	fireEventAppendFailed(ch.qos.logback.classic.spi.ILoggingEvent event, Throwable reason)
String	getCustomFields()
List<String>	getExcludeMdcKeyNames()
LogstashFieldNames	getFieldNames()
String	getHost()
List<String>	getIncludeMdcKeyNames()
JsonFactoryDecorator	getJsonFactoryDecorator()
JsonGeneratorDecorator	getJsonGeneratorDecorator()
String	getNonStructuredArgumentsFieldPrefix()
ch.qos.logback.core.Layout<ch.qos.logback.classic.spi.ILoggingEvent>	getPrefix()
int	getSeverityForEvent(Object eventObject)
int	getShortenedLoggerNameLength()
ch.qos.logback.core.Layout<ch.qos.logback.classic.spi.ILoggingEvent>	getSuffix()
ch.qos.logback.classic.pattern.ThrowableHandlingConverter	getThrowableConverter()
String	getTimeZone()
boolean	isIncludeCallerData()
boolean	isIncludeCallerInfo() Deprecated. use isIncludeCallerData() (to use the same name that logback uses)
boolean	isIncludeContext()
boolean	isIncludeMdc()
boolean	isIncludeNonStructuredArguments()
boolean	isIncludeStructuredArguments()
void	removeListener(AppenderListener<ch.qos.logback.classic.spi.ILoggingEvent> listener)
void	setCustomFields(String customFields)
void	setExcludeMdcKeyNames(List<String> excludeMdcKeyNames)
void	setFieldNames(LogstashFieldNames fieldNames)
void	setFindAndRegisterJacksonModules(boolean findAndRegisterJacksonModules)
void	setHost(String host) Just an alias for syslogHost (since that name doesn't make much sense here)
void	setIncludeCallerData(boolean includeCallerData)
void	setIncludeCallerInfo(boolean includeCallerInfo) Deprecated. use setIncludeCallerData(boolean) (to use the same name that logback uses)
void	setIncludeContext(boolean includeContext)
void	setIncludeMdc(boolean includeMdc)
void	setIncludeMdcKeyNames(List<String> includeMdcKeyNames)
void	setIncludeNonStructuredArguments(boolean includeNonStructuredArguments)
void	setIncludeStructuredArguments(boolean includeStructuredArguments)
void	setJsonFactoryDecorator(JsonFactoryDecorator jsonFactoryDecorator)
void	setJsonGeneratorDecorator(JsonGeneratorDecorator jsonGeneratorDecorator)
void	setNonStructuredArgumentsFieldPrefix(String nonStructuredArgumentsFieldPrefix)
void	setPrefix(ch.qos.logback.core.Layout<ch.qos.logback.classic.spi.ILoggingEvent> prefix)
void	setShortenedLoggerNameLength(int length)
void	setSuffix(ch.qos.logback.core.Layout<ch.qos.logback.classic.spi.ILoggingEvent> suffix)
void	setThrowableConverter(ch.qos.logback.classic.pattern.ThrowableHandlingConverter throwableConverter)
void	setTimeZone(String timeZoneId)
void	start()
void	stop()

Methods inherited from class ch.qos.logback.core.net.SyslogAppenderBase

facilityStringToint, getCharset, getFacility, getLayout, getMaxMessageSize, getPort, getSuffixPattern, getSyslogHost, postProcess, setCharset, setFacility, setLayout, setMaxMessageSize, setPort, setSuffixPattern, setSyslogHost

Methods inherited from class ch.qos.logback.core.AppenderBase

addFilter, clearAllFilters, doAppend, getCopyOfAttachedFiltersList, getFilterChainDecision, getName, isStarted, setName, toString

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, wait, wait, wait

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

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

Constructor Detail

LogstashSocketAppender

public LogstashSocketAppender()

Method Detail

buildLayout

public ch.qos.logback.core.Layout<ch.qos.logback.classic.spi.ILoggingEvent> buildLayout()

Specified by:

buildLayout in class ch.qos.logback.core.net.SyslogAppenderBase<ch.qos.logback.classic.spi.ILoggingEvent>

start

public void start()

Specified by:

start in interface ch.qos.logback.core.spi.LifeCycle

Overrides:

start in class ch.qos.logback.core.net.SyslogAppenderBase<ch.qos.logback.classic.spi.ILoggingEvent>

stop

public void stop()

Specified by:

stop in interface ch.qos.logback.core.spi.LifeCycle

Overrides:

stop in class ch.qos.logback.core.net.SyslogAppenderBase<ch.qos.logback.classic.spi.ILoggingEvent>

append

protected void append(ch.qos.logback.classic.spi.ILoggingEvent eventObject)

Overrides:

append in class ch.qos.logback.core.net.SyslogAppenderBase<ch.qos.logback.classic.spi.ILoggingEvent>

fireAppenderStarted

protected void fireAppenderStarted()

fireAppenderStopped

protected void fireAppenderStopped()

fireEventAppended

protected void fireEventAppended(ch.qos.logback.classic.spi.ILoggingEvent event,
                                 long durationInNanos)

fireEventAppendFailed

protected void fireEventAppendFailed(ch.qos.logback.classic.spi.ILoggingEvent event,
                                     Throwable reason)

getSeverityForEvent

public int getSeverityForEvent(Object eventObject)

Specified by:

getSeverityForEvent in class ch.qos.logback.core.net.SyslogAppenderBase<ch.qos.logback.classic.spi.ILoggingEvent>

getHost

public String getHost()

setHost

public void setHost(String host)

Just an alias for syslogHost (since that name doesn't make much sense here)

Parameters:

host -

addProvider

public void addProvider(JsonProvider<ch.qos.logback.classic.spi.ILoggingEvent> provider)

setCustomFields

public void setCustomFields(String customFields)

getCustomFields

public String getCustomFields()

isIncludeCallerData

public boolean isIncludeCallerData()

setIncludeCallerData

public void setIncludeCallerData(boolean includeCallerData)

isIncludeCallerInfo

@Deprecated
public boolean isIncludeCallerInfo()

Deprecated. use isIncludeCallerData() (to use the same name that logback uses)

setIncludeCallerInfo

@Deprecated
public void setIncludeCallerInfo(boolean includeCallerInfo)

Deprecated. use setIncludeCallerData(boolean) (to use the same name that logback uses)

getFieldNames

public LogstashFieldNames getFieldNames()

setFieldNames

public void setFieldNames(LogstashFieldNames fieldNames)

isIncludeMdc

public boolean isIncludeMdc()

setIncludeMdc

public void setIncludeMdc(boolean includeMdc)

getIncludeMdcKeyNames

public List<String> getIncludeMdcKeyNames()

addIncludeMdcKeyName

public void addIncludeMdcKeyName(String includedMdcKeyName)

setIncludeMdcKeyNames

public void setIncludeMdcKeyNames(List<String> includeMdcKeyNames)

getExcludeMdcKeyNames

public List<String> getExcludeMdcKeyNames()

addExcludeMdcKeyName

public void addExcludeMdcKeyName(String excludedMdcKeyName)

setExcludeMdcKeyNames

public void setExcludeMdcKeyNames(List<String> excludeMdcKeyNames)

isIncludeContext

public boolean isIncludeContext()

setIncludeContext

public void setIncludeContext(boolean includeContext)

isIncludeStructuredArguments

public boolean isIncludeStructuredArguments()

setIncludeStructuredArguments

public void setIncludeStructuredArguments(boolean includeStructuredArguments)

isIncludeNonStructuredArguments

public boolean isIncludeNonStructuredArguments()

setIncludeNonStructuredArguments

public void setIncludeNonStructuredArguments(boolean includeNonStructuredArguments)

getNonStructuredArgumentsFieldPrefix

public String getNonStructuredArgumentsFieldPrefix()

setNonStructuredArgumentsFieldPrefix

public void setNonStructuredArgumentsFieldPrefix(String nonStructuredArgumentsFieldPrefix)

getShortenedLoggerNameLength

public int getShortenedLoggerNameLength()

setShortenedLoggerNameLength

public void setShortenedLoggerNameLength(int length)

getJsonFactoryDecorator

public JsonFactoryDecorator getJsonFactoryDecorator()

setJsonFactoryDecorator

public void setJsonFactoryDecorator(JsonFactoryDecorator jsonFactoryDecorator)

getJsonGeneratorDecorator

public JsonGeneratorDecorator getJsonGeneratorDecorator()

setJsonGeneratorDecorator

public void setJsonGeneratorDecorator(JsonGeneratorDecorator jsonGeneratorDecorator)

setFindAndRegisterJacksonModules

public void setFindAndRegisterJacksonModules(boolean findAndRegisterJacksonModules)

getTimeZone

public String getTimeZone()

setTimeZone

public void setTimeZone(String timeZoneId)

getThrowableConverter

public ch.qos.logback.classic.pattern.ThrowableHandlingConverter getThrowableConverter()

setThrowableConverter

public void setThrowableConverter(ch.qos.logback.classic.pattern.ThrowableHandlingConverter throwableConverter)

getPrefix

public ch.qos.logback.core.Layout<ch.qos.logback.classic.spi.ILoggingEvent> getPrefix()

setPrefix

public void setPrefix(ch.qos.logback.core.Layout<ch.qos.logback.classic.spi.ILoggingEvent> prefix)

getSuffix

public ch.qos.logback.core.Layout<ch.qos.logback.classic.spi.ILoggingEvent> getSuffix()

setSuffix

public void setSuffix(ch.qos.logback.core.Layout<ch.qos.logback.classic.spi.ILoggingEvent> suffix)

addListener

public void addListener(AppenderListener<ch.qos.logback.classic.spi.ILoggingEvent> listener)

removeListener

public void removeListener(AppenderListener<ch.qos.logback.classic.spi.ILoggingEvent> listener)

createOutputStream

public ch.qos.logback.core.net.SyslogOutputStream createOutputStream()
                                                              throws UnknownHostException,
                                                                     SocketException

Specified by:

createOutputStream in class ch.qos.logback.core.net.SyslogAppenderBase<ch.qos.logback.classic.spi.ILoggingEvent>

Throws:

UnknownHostException

SocketException