Package org.apache.nifi.logging

Interface ComponentLog

All Known Implementing Classes:

NopComponentLog

public interface ComponentLog

The ComponentLog provides a mechanism to ensure that all NiFi components are logging and reporting information in a consistent way. When messages are logged to the ComponentLog, each message has the following characteristics:

• The toString() of the component is automatically prepended to the message so that it is clear which component is providing the information. This is important, since a single component may have many different instances within the same NiFi instance.
• If the last value in an Object... argument that is passed to the logger is a Throwable, then the logged message will include a toString() of the Throwable; in addition, if the component's logger is set to DEBUG level via the logback configuration, the Stacktrace will also be logged. This provides a mechanism to easily enable stacktraces in the logs when they are desired without filling the logs with unneeded stack traces for messages that end up occurring often.
• Any message that is logged with a Severity level that meets or exceeds the configured Bulletin Level for that component will also cause a Bulletin to be generated, so that the message is visible in the UI, allowing Dataflow Managers to understand that a problem exists and what the issue is.

Method Summary

Modifier and Type	Method	Description
void	debug(String msg)
void	debug(String msg, Object... os)
void	debug(String msg, Throwable t)
default void	debug(LogMessage logMessage)
void	error(String msg)
void	error(String msg, Object... os)
void	error(String msg, Throwable t)
default void	error(LogMessage logMessage)
String	getName()
void	info(String msg)
void	info(String msg, Object... os)
void	info(String msg, Throwable t)
default void	info(LogMessage logMessage)
boolean	isDebugEnabled()
boolean	isErrorEnabled()
boolean	isInfoEnabled()
boolean	isTraceEnabled()
boolean	isWarnEnabled()
default void	log(LogLevel level, String msg)
default void	log(LogLevel level, String msg, Object... os)
default void	log(LogLevel level, String msg, Throwable t)
default void	log(LogLevel level, LogMessage logMessage)
default void	log(LogMessage message)
void	trace(String msg)
void	trace(String msg, Object... os)
void	trace(String msg, Throwable t)
default void	trace(LogMessage logMessage)
void	warn(String msg)
void	warn(String msg, Object... os)
void	warn(String msg, Throwable t)
default void	warn(LogMessage logMessage)

Method Details

warn

void warn(String msg,
 Throwable t)

warn

void warn(String msg,
 Object... os)

warn

void warn(String msg)

warn

default void warn(LogMessage logMessage)

trace

void trace(String msg,
 Throwable t)

trace

void trace(String msg,
 Object... os)

trace

void trace(String msg)

trace

default void trace(LogMessage logMessage)

isWarnEnabled

boolean isWarnEnabled()

isTraceEnabled

boolean isTraceEnabled()

isInfoEnabled

boolean isInfoEnabled()

isErrorEnabled

boolean isErrorEnabled()

isDebugEnabled

boolean isDebugEnabled()

info

void info(String msg,
 Throwable t)

info

void info(String msg,
 Object... os)

info

void info(String msg)

info

default void info(LogMessage logMessage)

getName

String getName()

error

void error(String msg,
 Throwable t)

error

void error(String msg,
 Object... os)

error

void error(String msg)

error

default void error(LogMessage logMessage)

debug

void debug(String msg,
 Throwable t)

debug

void debug(String msg,
 Object... os)

debug

void debug(String msg)

debug

default void debug(LogMessage logMessage)

log

default void log(LogLevel level,
 String msg,
 Throwable t)

log

default void log(LogLevel level,
 String msg,
 Object... os)

log

default void log(LogLevel level,
 String msg)

log

default void log(LogMessage message)

log

default void log(LogLevel level,
 LogMessage logMessage)