io.dropwizard.logging

Class ConsoleAppenderFactory<E extends ch.qos.logback.core.spi.DeferredProcessingAware>

java.lang.Object

io.dropwizard.logging.AbstractAppenderFactory<E>

io.dropwizard.logging.ConsoleAppenderFactory<E>

All Implemented Interfaces:

Discoverable, AppenderFactory<E>

public class ConsoleAppenderFactory<E extends ch.qos.logback.core.spi.DeferredProcessingAware>
extends AbstractAppenderFactory<E>

An AppenderFactory implementation which provides an appender that writes events to the console.

Configuration Parameters:

Name	Default	Description
type	REQUIRED	The appender type. Must be console.
threshold	ALL	The lowest level of events to print to the console.
timeZone	UTC	The time zone to which event timestamps will be converted.
target	stdout	The name of the standard stream to which events will be written. Can be stdout or stderr.
logFormat	the default format	The Logback pattern with which events will be formatted. See the Logback documentation for details.

See Also:

AbstractAppenderFactory

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ConsoleAppenderFactory.ConsoleStream

Field Summary

Fields inherited from class io.dropwizard.logging.AbstractAppenderFactory

logFormat, threshold, timeZone

Constructor Summary

Constructors

Constructor and Description
ConsoleAppenderFactory()

Method Summary

Modifier and Type	Method and Description
ch.qos.logback.core.Appender<E>	build(ch.qos.logback.classic.LoggerContext context, String applicationName, LayoutFactory<E> layoutFactory, LevelFilterFactory<E> levelFilterFactory, AsyncAppenderFactory<E> asyncAppenderFactory) Given a Logback context, an application name, a layout, a levelFilterFactory, and an asyncAppenderFactory build a new appender.
ConsoleAppenderFactory.ConsoleStream	getTarget()
void	setTarget(ConsoleAppenderFactory.ConsoleStream target)

Methods inherited from class io.dropwizard.logging.AbstractAppenderFactory

buildLayout, getDiscardingThreshold, getFilterFactories, getLogFormat, getQueueSize, getThreshold, getTimeZone, isIncludeCallerData, setDiscardingThreshold, setFilterFactories, setIncludeCallerData, setLogFormat, setQueueSize, setThreshold, setTimeZone, wrapAsync, wrapAsync

Methods inherited from class java.lang.Object

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

Constructor Detail

ConsoleAppenderFactory

public ConsoleAppenderFactory()

Method Detail

getTarget

public ConsoleAppenderFactory.ConsoleStream getTarget()

setTarget

public void setTarget(ConsoleAppenderFactory.ConsoleStream target)

build

public ch.qos.logback.core.Appender<E> build(ch.qos.logback.classic.LoggerContext context,
                                             String applicationName,
                                             LayoutFactory<E> layoutFactory,
                                             LevelFilterFactory<E> levelFilterFactory,
                                             AsyncAppenderFactory<E> 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