Top Description Fields Constructors Methods
ch.qos.logback.classic.net

public Class SyslogAppender

extends SyslogAppenderBase<ILoggingEvent>
Class Inheritance
Imports
java.io.IOException, .OutputStream, java.net.SocketException, .UnknownHostException, ch.qos.logback.classic.PatternLayout, ch.qos.logback.classic.pattern.SyslogStartConverter, ch.qos.logback.classic.spi.ILoggingEvent, .IThrowableProxy, .StackTraceElementProxy, ch.qos.logback.classic.util.LevelToSyslogSeverity, ch.qos.logback.core.CoreConstants, .Layout, ch.qos.logback.core.net.SyslogAppenderBase, .SyslogOutputStream
This appender can be used to send messages to a remote syslog daemon.

For more information about this appender, please refer to the online manual at http://logback.qos.ch/manual/appenders.html#SyslogAppender

Author
Ceki Gülcü

Field Summary

Modifier and TypeField and Description
public static final String
DEFAULT_STACKTRACE_PATTERN

public static final String
DEFAULT_SUFFIX_PATTERN

pack-priv PatternLayout
stackTraceLayout

pack-priv String
stackTracePattern

pack-priv boolean
throwableExcluded

Inherited from ch.qos.logback.core.net.SyslogAppenderBase:
suffixPattern

Constructor Summary

AccessConstructor and Description
public
SyslogAppender()

Method Summary

Modifier and TypeMethod and Description
public Layout<ILoggingEvent>
buildLayout()

Implements abstract ch.qos.logback.core.net.SyslogAppenderBase.buildLayout.

public SyslogOutputStream
createOutputStream()

Implements abstract ch.qos.logback.core.net.SyslogAppenderBase.createOutputStream.

pack-priv String
getPrefixPattern()

public int
getSeverityForEvent(Object eventObject)

Implements abstract ch.qos.logback.core.net.SyslogAppenderBase.getSeverityForEvent.

Convert a level to equivalent syslog severity.
public String

Returns:

the stackTraceSuffixPattern
getStackTracePattern()

See {@link #setStackTracePattern(String).

private void
handleThrowableFirstLine(OutputStream sw, IThrowableProxy tp, String stackTracePrefix, boolean isRootException)

public boolean
isThrowableExcluded()

protected void
postProcess(Object eventObject, OutputStream sw)

Overrides ch.qos.logback.core.net.SyslogAppenderBase.postProcess.

public void
setStackTracePattern(String stackTracePattern)

Stack trace lines are sent to the syslog server separately from the main message For stack trace lines, the stackTracePattern is used instead of suffixPattern.

public void
setThrowableExcluded(boolean throwableExcluded)

Setting throwableExcluded to true causes no Throwable's stack trace data to be sent to the syslog daemon.

private void
setupStackTraceLayout()

pack-priv boolean
stackTraceHeaderLine(StringBuilder sb, boolean topException)

public void
start()

Overrides ch.qos.logback.core.net.SyslogAppenderBase.start.

Implements ch.qos.logback.core.spi.LifeCycle.start.

Inherited from ch.qos.logback.core.net.SyslogAppenderBase:
appendfacilityStringTointgetCharsetgetFacilitygetLayoutgetMaxMessageSizegetPortgetSuffixPatterngetSyslogHostsetCharsetsetFacilitysetLayoutsetMaxMessageSizesetPortsetSuffixPatternsetSyslogHoststop

Field Detail

DEFAULT_STACKTRACE_PATTERNback to summary
public static final String DEFAULT_STACKTRACE_PATTERN
DEFAULT_SUFFIX_PATTERNback to summary
public static final String DEFAULT_SUFFIX_PATTERN
stackTraceLayoutback to summary
pack-priv PatternLayout stackTraceLayout
stackTracePatternback to summary
pack-priv String stackTracePattern
throwableExcludedback to summary
pack-priv boolean throwableExcluded

Constructor Detail

SyslogAppenderback to summary
public SyslogAppender()

Method Detail

buildLayoutback to summary
public Layout<ILoggingEvent> buildLayout()

Implements abstract ch.qos.logback.core.net.SyslogAppenderBase.buildLayout.

createOutputStreamback to summary
public SyslogOutputStream createOutputStream() throws SocketException, UnknownHostException

Implements abstract ch.qos.logback.core.net.SyslogAppenderBase.createOutputStream.

Annotations
@Override
getPrefixPatternback to summary
pack-priv String getPrefixPattern()
getSeverityForEventback to summary
public int getSeverityForEvent(Object eventObject)

Implements abstract ch.qos.logback.core.net.SyslogAppenderBase.getSeverityForEvent.

Convert a level to equivalent syslog severity. Only levels for printing methods i.e. DEBUG, WARN, INFO and ERROR are converted.

Annotations
@Override
See Also
ch.qos.logback.core.net.SyslogAppenderBase#getSeverityForEvent(java.lang.Object)
getStackTracePatternback to summary
public String getStackTracePattern()

See {@link #setStackTracePattern(String).

Returns:String

the stackTraceSuffixPattern

Since
1.0.4
handleThrowableFirstLineback to summary
private void handleThrowableFirstLine(OutputStream sw, IThrowableProxy tp, String stackTracePrefix, boolean isRootException) throws IOException
isThrowableExcludedback to summary
public boolean isThrowableExcluded()
postProcessback to summary
protected void postProcess(Object eventObject, OutputStream sw)

Overrides ch.qos.logback.core.net.SyslogAppenderBase.postProcess.

Annotations
@Override
setStackTracePatternback to summary
public void setStackTracePattern(String stackTracePattern)

Stack trace lines are sent to the syslog server separately from the main message For stack trace lines, the stackTracePattern is used instead of suffixPattern. The stackTracePattern option allows specification of a separate format for the non-standardized part of stack trace lines.

Since
1.0.4
setThrowableExcludedback to summary
public void setThrowableExcluded(boolean throwableExcluded)

Setting throwableExcluded to true causes no Throwable's stack trace data to be sent to the syslog daemon. By default, stack trace data is sent to syslog daemon.

Since
1.0.4
setupStackTraceLayoutback to summary
private void setupStackTraceLayout()
stackTraceHeaderLineback to summary
pack-priv boolean stackTraceHeaderLine(StringBuilder sb, boolean topException)
startback to summary
public void start()

Overrides ch.qos.logback.core.net.SyslogAppenderBase.start.

Implements ch.qos.logback.core.spi.LifeCycle.start.