org.apache.drill.test

Class LogFixture.LogFixtureBuilder

java.lang.Object

org.apache.drill.test.LogFixture.LogFixtureBuilder

Enclosing class:

LogFixture

public static class LogFixture.LogFixtureBuilder
extends Object

Builds the log settings to be used for a test. The log settings here add to those specified in a logback.xml or logback-test.xml file on your class path. In particular, if the logging configuration already redirects the Drill logger to the console, setting console logging here does nothing.

Constructor Summary

Constructors

Constructor and Description
LogFixtureBuilder()

Method Summary

Modifier and Type	Method and Description
LogFixture	build() Apply the log levels and output, then return a fixture to be used in a try-with-resources block.
LogFixture.LogFixtureBuilder	disable() Turns off all logging.
LogFixture.LogFixtureBuilder	logger(Class<?> loggerClass, ch.qos.logback.classic.Level level) Set a specific logger to the given level.
LogFixture.LogFixtureBuilder	logger(String loggerName, ch.qos.logback.classic.Level level) Set a specific logger to the given level.
LogFixture.LogFixtureBuilder	rootLogger(ch.qos.logback.classic.Level level) Set the desired log level on the root logger.
LogFixture.LogFixtureBuilder	toConsole() Send all enabled logging to the console (if not already configured.) Some Drill log configuration files send the root to the console (or file), but the Drill loggers to Lilith.
LogFixture.LogFixtureBuilder	toConsole(ch.qos.logback.core.ConsoleAppender<ch.qos.logback.classic.spi.ILoggingEvent> appender, String format)
LogFixture.LogFixtureBuilder	toConsole(String format) Send logging to the console using the defined format.

Methods inherited from class java.lang.Object

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

Constructor Detail

LogFixtureBuilder

public LogFixtureBuilder()

Method Detail

toConsole

public LogFixture.LogFixtureBuilder toConsole()

Send all enabled logging to the console (if not already configured.) Some Drill log configuration files send the root to the console (or file), but the Drill loggers to Lilith. In that case, Lilith "hides" the console logger. Using this call adds a console logger to the Drill logger so that output does, in fact, go to the console regardless of the configuration in the Logback configuration file.

Returns:

this builder

toConsole

public LogFixture.LogFixtureBuilder toConsole(ch.qos.logback.core.ConsoleAppender<ch.qos.logback.classic.spi.ILoggingEvent> appender,
                                              String format)

toConsole

public LogFixture.LogFixtureBuilder toConsole(String format)

Send logging to the console using the defined format.

Parameters:

format - valid Logback log format

Returns:

this builder

logger

public LogFixture.LogFixtureBuilder logger(String loggerName,
                                           ch.qos.logback.classic.Level level)

Set a specific logger to the given level.

Parameters:

loggerName - name of the logger (typically used for package-level loggers)

level - the desired Logback-defined level

Returns:

this builder

logger

public LogFixture.LogFixtureBuilder logger(Class<?> loggerClass,
                                           ch.qos.logback.classic.Level level)

Set a specific logger to the given level.

Parameters:

loggerClass - class that defines the logger (typically used for class-specific loggers)

level - the desired Logback-defined level

Returns:

this builder

disable

public LogFixture.LogFixtureBuilder disable()

Turns off all logging. If called first, you can set disable as your general policy, then turn back on loggers selectively for those of interest.

Returns:

this builder

rootLogger

public LogFixture.LogFixtureBuilder rootLogger(ch.qos.logback.classic.Level level)

Set the desired log level on the root logger.

Parameters:

level - the desired Logback log level

Returns:

this builder

build

public LogFixture build()

Apply the log levels and output, then return a fixture to be used in a try-with-resources block. The fixture automatically restores the original configuration on completion of the try block.

Returns:

the log fixture