io.dropwizard.logging

Class ConsoleAppenderFactory

java.lang.Object

io.dropwizard.logging.AbstractAppenderFactory

io.dropwizard.logging.ConsoleAppenderFactory

All Implemented Interfaces:

Discoverable, AppenderFactory

public class ConsoleAppenderFactory
extends AbstractAppenderFactory

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

Constructor Summary

Constructors

Constructor and Description
ConsoleAppenderFactory()

Method Summary

Methods

Modifier and Type	Method and Description
ch.qos.logback.core.Appender<ch.qos.logback.classic.spi.ILoggingEvent>	build(ch.qos.logback.classic.LoggerContext context, String applicationName, ch.qos.logback.core.Layout<ch.qos.logback.classic.spi.ILoggingEvent> layout) Given a Logback context, an application name, and a layout, build a new appender.
ConsoleAppenderFactory.ConsoleStream	getTarget()
TimeZone	getTimeZone()
void	setTarget(ConsoleAppenderFactory.ConsoleStream target)
void	setTimeZone(TimeZone timeZone)

Methods inherited from class io.dropwizard.logging.AbstractAppenderFactory

addThresholdFilter, buildLayout, getBatchDuration, getBatchSize, getLogFormat, getThreshold, isBounded, setBatchDuration, setBatchSize, setBounded, setLogFormat, setThreshold, 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

getTimeZone

public TimeZone getTimeZone()

setTimeZone

public void setTimeZone(TimeZone timeZone)

getTarget

public ConsoleAppenderFactory.ConsoleStream getTarget()

setTarget

public void setTarget(ConsoleAppenderFactory.ConsoleStream target)

build

public ch.qos.logback.core.Appender<ch.qos.logback.classic.spi.ILoggingEvent> build(ch.qos.logback.classic.LoggerContext context,
                                                                           String applicationName,
                                                                           ch.qos.logback.core.Layout<ch.qos.logback.classic.spi.ILoggingEvent> layout)

Description copied from interface: AppenderFactory

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

Parameters:

context - the Logback context

applicationName - the application name

layout - the layout for logging

Returns:

a new, started Appender