org.knime.core.node

Class NodeLogger

java.lang.Object

org.knime.core.node.NodeLogger

public final class NodeLogger
extends Object

The general logger used to write info, warnings, errors , debugging, assert messages, exceptions, and coding problems into the internal Log4J logger. The loggers are configured by the log4j.properties file in the root of the core package. The configuration can be overridden by specifying a file in -Dlog4j.configuration (this is the standard log4j behaviour). Furthermore, it is possible to add and remove additional writers to this logger. Note, calling setLevel(LEVEL) does only effect the minimum logging level of the default loggers. All other writers' levels have to be set before hand.

Author:

Thomas Gabriel, Tobias Koetter, KNIME.com

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
(package private) class	NodeLogger.KNIMELogMessage Class that encapsulates all information of a log message in KNIME such as the NodeID and workflow directory if the message can be assigned to them.
static class	NodeLogger.LEVEL The logging levels.

Field Summary

Fields

Modifier and Type	Field and Description
static String	KNIME_CONSOLE_APPENDER Name of the default appender to the KNIME console.
static String	LOG_FILE The default log file name, knime.log.
static String	LOGFILE_APPENDER Name of the default appender to the log file.
static String	STDERR_APPENDER Name of the default appender to System.err.
static String	STDOUT_APPENDER Name of the default appender to System.out.

Method Summary

Modifier and Type	Method and Description
static void	addKNIMEConsoleWriter(Writer writer, NodeLogger.LEVEL minLevel, NodeLogger.LEVEL maxLevel) Adds a new Writer with the given level to this logger.
static void	addWriter(Writer writer, Layout layout, NodeLogger.LEVEL minLevel, NodeLogger.LEVEL maxLevel) Adds a new Writer with the given level to this logger.
static void	addWriter(Writer writer, NodeLogger.LEVEL minLevel, NodeLogger.LEVEL maxLevel) Adds a new Writer with the given level to this logger.
void	assertLog(boolean b, String m) Check assert and write into logger if failed.
void	assertLog(boolean b, String m, AssertionError e) Check assertions on/off and write debug message into logger.
void	coding(Object o) Writes CODING PROBLEM plus this message into this logger as error.
void	coding(Object o, Throwable t) Writes CODING PROBLEM plus this message, as well as the the message of the throwable into this logger as error and debug.
void	codingWithFormat(String format, Object... args) Write coding message, created by String.format(String, Object...) into this logger.
void	debug(Object o) Write debugging message into this logger.
void	debug(Object o, Throwable t) Write debugging message and throwable into this logger.
void	debugWithFormat(String format, Object... args) Write debug message, created by String.format(String, Object...) into this logger.
void	debugWithoutContext(Object o) Write debugging message into this logger.
void	error(Object o) Write error message into the logger.
void	error(Object o, Throwable t) Write error message and throwable into the logger.
void	errorWithFormat(String format, Object... args) Write error message, created by String.format(String, Object...) into this logger.
void	fatal(Object o) Write fatal error message into the logger.
void	fatal(Object o, Throwable t) Write fatal error message and throwable into the logger.
void	fatalWithFormat(String format, Object... args) Write fatal message, created by String.format(String, Object...) into this logger.
NodeLogger.LEVEL	getLevel() Returns the minimum logging retrieved from the underlying Log4J logger.
static NodeLogger	getLogger(Class<?> c) Creates a new NodeLogger for the given Class.
static NodeLogger	getLogger(String s) Creates a new NodeLogger for the given name.
void	info(Object o) Write info message into this logger.
void	info(Object o, Throwable t) Write info message and throwable into this logger.
void	infoWithFormat(String format, Object... args) Write info message, created by String.format(String, Object...) into this logger.
boolean	isDebugEnabled() Checks if debug logging level is enabled.
boolean	isEnabledFor(NodeLogger.LEVEL level) Returns true if the underlying Log4J logger is enabled for the given level.
boolean	isInfoEnabled() Checks if info logging level is enabled.
static void	logGlobalMsgsInWfDir(boolean enable) Allows to enable/disable logging of global messages e.g.
static void	logInWorkflowDir(boolean enable) Allows to enable/disable logging in the workflow directory.
static void	logNodeId(boolean enable) Allows to enable/disable node id logging.
static void	removeWriter(Writer writer) Removes the previously added Writer from the logger.
static void	setAppenderLevelRange(String appenderName, NodeLogger.LEVEL min, NodeLogger.LEVEL max) Sets a level range filter on the given appender.
static void	setLevel(NodeLogger.LEVEL level) Deprecated. user setAppenderLevelRange(String, LEVEL, LEVEL) instead for more fine-grained control
static void	setLevelIntern(NodeLogger.LEVEL level) Deprecated.
void	warn(Object o) Write warning message into this logger.
void	warn(Object o, Throwable t) Write warning message and throwable into this logger.
void	warnWithFormat(String format, Object... args) Write warning message, created by String.format(String, Object...) into this logger.

Methods inherited from class java.lang.Object

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

Field Detail

STDOUT_APPENDER

public static final String STDOUT_APPENDER

Name of the default appender to System.out.

Since:

2.8

See Also:

Constant Field Values

STDERR_APPENDER

public static final String STDERR_APPENDER

Name of the default appender to System.err.

Since:

2.8

See Also:

Constant Field Values

LOGFILE_APPENDER

public static final String LOGFILE_APPENDER

Name of the default appender to the log file.

Since:

2.8

See Also:

Constant Field Values

KNIME_CONSOLE_APPENDER

public static final String KNIME_CONSOLE_APPENDER

Name of the default appender to the KNIME console.

Since:

2.12

See Also:

Constant Field Values

LOG_FILE

public static final String LOG_FILE

The default log file name, knime.log.

See Also:

Constant Field Values

Method Detail

getLogger

public static NodeLogger getLogger(Class<?> c)

Creates a new NodeLogger for the given Class.

Parameters:

c - The logger's Class.

Returns:

A new logger for this Class.

getLogger

public static NodeLogger getLogger(String s)

Creates a new NodeLogger for the given name.

Parameters:

s - The logger's String.

Returns:

A new logger for the given name.

warn

public void warn(Object o)

Write warning message into this logger.

Parameters:

o - The object to print.

debug

public void debug(Object o)

Write debugging message into this logger.

Parameters:

o - The object to print.

debugWithoutContext

public void debugWithoutContext(Object o)

Write debugging message into this logger. The message is logged without a node context. This method should only be used when you know that there is no node context available.

Parameters:

o - The object to print.

Since:

3.1

info

public void info(Object o)

Write info message into this logger.

Parameters:

o - The object to print.

error

public void error(Object o)

Write error message into the logger.

Parameters:

o - The object to print.

fatal

public void fatal(Object o)

Write fatal error message into the logger.

Parameters:

o - The object to print.

warn

public void warn(Object o,
                 Throwable t)

Write warning message and throwable into this logger.

Parameters:

o - The object to print.

t - The exception to log at debug level, including its stack trace.

debug

public void debug(Object o,
                  Throwable t)

Write debugging message and throwable into this logger.

Parameters:

o - The object to print.

t - The exception to log, including its stack trace.

info

public void info(Object o,
                 Throwable t)

Write info message and throwable into this logger.

Parameters:

o - The object to print.

t - The exception to log at debug level, including its stack trace.

error

public void error(Object o,
                  Throwable t)

Write error message and throwable into the logger.

Parameters:

o - The object to print.

t - The exception to log at debug level, including its stack trace.

assertLog

public void assertLog(boolean b,
                      String m)

Check assert and write into logger if failed.

Parameters:

b - The expression to check.

m - Print this message if failed.

assertLog

public void assertLog(boolean b,
                      String m,
                      AssertionError e)

Check assertions on/off and write debug message into logger.

Parameters:

b - The expression to check.

m - Print this message if failed.

e - AssertionError which as been fired.

coding

public void coding(Object o)

Writes CODING PROBLEM plus this message into this logger as error. The event is only logged if assertions are enabled or KNIME is run from within the SDK.

Parameters:

o - the message to print

coding

public void coding(Object o,
                   Throwable t)

Writes CODING PROBLEM plus this message, as well as the the message of the throwable into this logger as error and debug. The event is only logged if assertions are enabled or KNIME is run from within the SDK.

Parameters:

o - the message to print

t - the exception to log at debug level, including its stack trace

fatal

public void fatal(Object o,
                  Throwable t)

Write fatal error message and throwable into the logger.

Parameters:

o - The object to print.

t - The exception to log at debug level, including its stack trace.

warnWithFormat

public void warnWithFormat(String format,
                           Object... args)

Write warning message, created by String.format(String, Object...) into this logger. The String is only formatted if actually necessary.

Parameters:

format - the format for printing

args - the arguments for String.format(String, Object...)

Throws:

NullPointerException - if format argument is null

Since:

2.10

debugWithFormat

public void debugWithFormat(String format,
                            Object... args)

Write debug message, created by String.format(String, Object...) into this logger. The String is only formatted if actually necessary.

Parameters:

format - the format for printing

args - the arguments for String.format(String, Object...)

Throws:

NullPointerException - if format argument is null

Since:

2.10

infoWithFormat

public void infoWithFormat(String format,
                           Object... args)

Write info message, created by String.format(String, Object...) into this logger. The String is only formatted if actually necessary.

Parameters:

format - the format for printing

args - the arguments for String.format(String, Object...)

Throws:

NullPointerException - if format argument is null

Since:

2.10

errorWithFormat

public void errorWithFormat(String format,
                            Object... args)

Write error message, created by String.format(String, Object...) into this logger. The String is only formatted if actually necessary.

Parameters:

format - the format for printing

args - the arguments for String.format(String, Object...)

Throws:

NullPointerException - if format argument is null

Since:

2.10

fatalWithFormat

public void fatalWithFormat(String format,
                            Object... args)

Write fatal message, created by String.format(String, Object...) into this logger. The String is only formatted if actually necessary.

Parameters:

format - the format for printing

args - the arguments for String.format(String, Object...)

Throws:

NullPointerException - if format argument is null

Since:

2.10

codingWithFormat

public void codingWithFormat(String format,
                             Object... args)

Write coding message, created by String.format(String, Object...) into this logger. The String is only formatted if actually necessary.

Parameters:

format - the format for printing

args - the arguments for String.format(String, Object...)

Throws:

NullPointerException - if format argument is null

Since:

2.10

addWriter

public static void addWriter(Writer writer,
                             NodeLogger.LEVEL minLevel,
                             NodeLogger.LEVEL maxLevel)

Adds a new Writer with the given level to this logger.

Parameters:

writer - The writer to add.

minLevel - The minimum level to output.

maxLevel - The maximum level to output.

addKNIMEConsoleWriter

public static void addKNIMEConsoleWriter(Writer writer,
                                         NodeLogger.LEVEL minLevel,
                                         NodeLogger.LEVEL maxLevel)

Adds a new Writer with the given level to this logger.

Parameters:

writer - The writer to add.

minLevel - The minimum level to output.

maxLevel - The maximum level to output.

Since:

2.12

addWriter

public static void addWriter(Writer writer,
                             Layout layout,
                             NodeLogger.LEVEL minLevel,
                             NodeLogger.LEVEL maxLevel)

Adds a new Writer with the given level to this logger.

Parameters:

writer - The writer to add.

layout - the log file layout to use

minLevel - The minimum level to output.

maxLevel - The maximum level to output.

Since:

2.12

removeWriter

public static void removeWriter(Writer writer)

Removes the previously added Writer from the logger.

Parameters:

writer - The Writer to remove.

setLevelIntern

@Deprecated
public static void setLevelIntern(NodeLogger.LEVEL level)

Deprecated.

Parameters:

level - minimum log level

See Also:

setLevel(NodeLogger.LEVEL)

setLevel

@Deprecated
public static void setLevel(NodeLogger.LEVEL level)

Deprecated. user setAppenderLevelRange(String, LEVEL, LEVEL) instead for more fine-grained control

Sets an new minimum logging level for all internal appenders, that are, log file, and System.out and System.err appender. The maximum logging level stays LEVEL.ALL for all appenders.

Parameters:

level - new minimum logging level

getLevel

public NodeLogger.LEVEL getLevel()

Returns the minimum logging retrieved from the underlying Log4J logger.

Returns:

minimum logging level

isDebugEnabled

public boolean isDebugEnabled()

Checks if debug logging level is enabled.

Returns:

true if debug logging level is enabled, otherwise false

isInfoEnabled

public boolean isInfoEnabled()

Checks if info logging level is enabled.

Returns:

true if info logging level is enabled, otherwise false

isEnabledFor

public boolean isEnabledFor(NodeLogger.LEVEL level)

Returns true if the underlying Log4J logger is enabled for the given level.

Parameters:

level - to test logging enabled

Returns:

true if logging is enabled, otherwise false

setAppenderLevelRange

public static void setAppenderLevelRange(String appenderName,
                                         NodeLogger.LEVEL min,
                                         NodeLogger.LEVEL max)
                                  throws NoSuchElementException

Sets a level range filter on the given appender.

Parameters:

appenderName - the name of the appender

min - the minimum logging level

max - the maximum logging level

Throws:

NoSuchElementException - if the given appender does not exist

Since:

2.8

logInWorkflowDir

public static void logInWorkflowDir(boolean enable)

Allows to enable/disable logging in the workflow directory. If enabled log messages that belong to workflow are logged into a log file within the workflow directory itself in addition to the global KNIME log file.

Parameters:

enable - true if workflow relative logging should be enabled

Since:

2.12

logGlobalMsgsInWfDir

public static void logGlobalMsgsInWfDir(boolean enable)

Allows to enable/disable logging of global messages e.g. message that are not related to a workflow into the workflow directory log file.

Parameters:

enable - true if workflow relative logging should be enabled

Since:

2.12

logNodeId

public static void logNodeId(boolean enable)

Allows to enable/disable node id logging. If enabled the node id information is added to the log events. This method should only be called to globally disable the node id logging since the flag is enabled automatically if one of the log file appender has a log layout that contains the node id pattern.

Parameters:

enable - false if workflow relative logging should be globally disabled

Since:

2.12