Package io.dropwizard.logging.common

Class SyslogAppenderFactory

java.lang.Object

io.dropwizard.logging.common.AbstractAppenderFactory<ch.qos.logback.classic.spi.ILoggingEvent>

io.dropwizard.logging.common.SyslogAppenderFactory

All Implemented Interfaces:

Discoverable, AppenderFactory<ch.qos.logback.classic.spi.ILoggingEvent>

public class SyslogAppenderFactory
extends AbstractAppenderFactory<ch.qos.logback.classic.spi.ILoggingEvent>

An AppenderFactory implementation which provides an appender that sends events to a syslog server.

Configuration Parameters:

Name	Default	Description
host	localhost	The hostname of the syslog server.
port	514	The port on which the syslog server is listening.
facility	local0	The syslog facility to use. Can be either auth, authpriv, daemon, cron, ftp, lpr, kern, mail, news, syslog, user, uucp, local0, local1, local2, local3, local4, local5, local6, or local7.
threshold	ALL	The lowest level of events to write to the file.
logFormat	the default format	The Logback pattern with which events will be formatted. See the Logback documentation for details.
includeStackTrace	include stack traces in log messages	Setting includeStackTrace to false causes no Throwable's stack trace data to be sent to the syslog daemon. By default, stack trace data is sent to syslog daemon. See the Logback documentation for details.

See Also:

• AbstractAppenderFactory

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	SyslogAppenderFactory.Facility

Field Summary

Fields inherited from class io.dropwizard.logging.common.AbstractAppenderFactory

layout, logFormat, threshold, timeZone

Constructor Summary

Constructors

Constructor	Description
SyslogAppenderFactory()

Method Summary

Modifier and Type	Method	Description
ch.qos.logback.core.Appender<ch.qos.logback.classic.spi.ILoggingEvent>	build(ch.qos.logback.classic.LoggerContext context, String applicationName, LayoutFactory<ch.qos.logback.classic.spi.ILoggingEvent> layoutFactory, LevelFilterFactory<ch.qos.logback.classic.spi.ILoggingEvent> levelFilterFactory, AsyncAppenderFactory<ch.qos.logback.classic.spi.ILoggingEvent> asyncAppenderFactory)	Given a Logback context, an application name, a layout, a levelFilterFactory, and an asyncAppenderFactory build a new appender.
SyslogAppenderFactory.Facility	getFacility()
String	getHost()	Returns the hostname of the syslog server.
boolean	getIncludeStackTrace()
int	getPort()
String	getStackTracePrefix()
void	setFacility(SyslogAppenderFactory.Facility facility)
void	setHost(String host)
void	setIncludeStackTrace(boolean includeStackTrace)
void	setPort(int port)
void	setStackTracePrefix(String stackTracePrefix)

Methods inherited from class io.dropwizard.logging.common.AbstractAppenderFactory

buildLayout, getDiscardingThreshold, getFilterFactories, getLayout, getLogFormat, getMessageRate, getQueueSize, getThreshold, getTimeZone, isIncludeCallerData, setDiscardingThreshold, setFilterFactories, setIncludeCallerData, setLayout, setLogFormat, setMessageRate, setNeverBlock, setQueueSize, setThreshold, setTimeZone, setTimeZone, wrapAsync, wrapAsync

Methods inherited from class java.lang.Object

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

Constructor Details

SyslogAppenderFactory

public SyslogAppenderFactory()

Method Details

getHost

public String getHost()

Returns the hostname of the syslog server.

setHost

public void setHost(String host)

getFacility

public SyslogAppenderFactory.Facility getFacility()

setFacility

public void setFacility(SyslogAppenderFactory.Facility facility)

getPort

public int getPort()

setPort

public void setPort(int port)

getIncludeStackTrace

public boolean getIncludeStackTrace()

setIncludeStackTrace

public void setIncludeStackTrace(boolean includeStackTrace)

getStackTracePrefix

public String getStackTracePrefix()

setStackTracePrefix

public void setStackTracePrefix(String stackTracePrefix)

build

public ch.qos.logback.core.Appender<ch.qos.logback.classic.spi.ILoggingEvent> build(ch.qos.logback.classic.LoggerContext context,
 String applicationName,
 LayoutFactory<ch.qos.logback.classic.spi.ILoggingEvent> layoutFactory,
 LevelFilterFactory<ch.qos.logback.classic.spi.ILoggingEvent> levelFilterFactory,
 AsyncAppenderFactory<ch.qos.logback.classic.spi.ILoggingEvent> asyncAppenderFactory)

Description copied from interface: AppenderFactory

Given a Logback context, an application name, a layout, a levelFilterFactory, and an asyncAppenderFactory build a new appender.

Parameters:

context - the Logback context

applicationName - the application name

layoutFactory - the factory for the layout for logging

levelFilterFactory - the factory for the level filter

asyncAppenderFactory - the factory for the async appender

Returns:

a new, started Appender