org.apache.nifi.logging

Interface ComponentLog

All Known Subinterfaces:

ProcessorLog

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 and Description
void	debug(String msg)
void	debug(String msg, Object[] os)
void	debug(String msg, Object[] os, Throwable t)
void	debug(String msg, Throwable t)
void	error(String msg)
void	error(String msg, Object[] os)
void	error(String msg, Object[] os, Throwable t)
void	error(String msg, Throwable t)
String	getName()
void	info(String msg)
void	info(String msg, Object[] os)
void	info(String msg, Object[] os, Throwable t)
void	info(String msg, Throwable t)
boolean	isDebugEnabled()
boolean	isErrorEnabled()
boolean	isInfoEnabled()
boolean	isTraceEnabled()
boolean	isWarnEnabled()
void	log(LogLevel level, String msg)
void	log(LogLevel level, String msg, Object[] os)
void	log(LogLevel level, String msg, Object[] os, Throwable t)
void	log(LogLevel level, String msg, Throwable t)
void	trace(String msg)
void	trace(String msg, Object[] os)
void	trace(String msg, Object[] os, Throwable t)
void	trace(String msg, Throwable t)
void	warn(String msg)
void	warn(String msg, Object[] os)
void	warn(String msg, Object[] os, Throwable t)
void	warn(String msg, Throwable t)

Method Detail

warn

void warn(String msg,
          Throwable t)

warn

void warn(String msg,
          Object[] os)

warn

void warn(String msg,
          Object[] os,
          Throwable t)

warn

void warn(String msg)

trace

void trace(String msg,
           Throwable t)

trace

void trace(String msg,
           Object[] os)

trace

void trace(String msg)

trace

void trace(String msg,
           Object[] os,
           Throwable t)

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

void info(String msg,
          Object[] os,
          Throwable t)

getName

String getName()

error

void error(String msg,
           Throwable t)

error

void error(String msg,
           Object[] os)

error

void error(String msg)

error

void error(String msg,
           Object[] os,
           Throwable t)

debug

void debug(String msg,
           Throwable t)

debug

void debug(String msg,
           Object[] os)

debug

void debug(String msg,
           Object[] os,
           Throwable t)

debug

void debug(String msg)

log

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

log

void log(LogLevel level,
         String msg,
         Object[] os)

log

void log(LogLevel level,
         String msg)

log

void log(LogLevel level,
         String msg,
         Object[] os,
         Throwable t)