org.apache.ignite.logger.log4j

Class Log4JLogger

java.lang.Object

org.apache.ignite.logger.log4j.Log4JLogger

All Implemented Interfaces:

IgniteLogger, LoggerNodeIdAware

public class Log4JLogger
extends Object
implements IgniteLogger, LoggerNodeIdAware

Log4j-based implementation for logging. This logger should be used by loaders that have prefer log4j-based logging.

Here is a typical example of configuring log4j logger in Ignite configuration file:

      <property name="gridLogger">
          <bean class="org.apache.ignite.grid.logger.log4j.GridLog4jLogger">
              <constructor-arg type="java.lang.String" value="config/ignite-log4j.xml"/>
          </bean>
      </property>
 

and from your code:

      IgniteConfiguration cfg = new IgniteConfiguration();
      ...
      URL xml = U.resolveIgniteUrl("config/custom-log4j.xml");
      IgniteLogger log = new Log4JLogger(xml);
      ...
      cfg.setGridLogger(log);
 

Please take a look at Apache Log4j 1.2 for additional information.

It's recommended to use Ignite logger injection instead of using/instantiating logger in your task/job code. See LoggerResource annotation about logger injection.

Constructor Summary

Constructors

Constructor and Description
Log4JLogger() Creates new logger and automatically detects if root logger already has appenders configured.
Log4JLogger(boolean init) Creates new logger.
Log4JLogger(File cfgFile) Creates new logger with given configuration cfgFile.
Log4JLogger(org.apache.log4j.Logger impl) Creates new logger with given implementation.
Log4JLogger(String path) Creates new logger with given configuration path.
Log4JLogger(URL cfgUrl) Creates new logger with given configuration cfgUrl.

Method Summary

Methods

Modifier and Type	Method and Description
static void	addAppender(org.apache.log4j.FileAppender a) Adds file appender.
void	debug(String msg)
void	error(String msg)
void	error(String msg, Throwable e)
String	fileName()
Log4JLogger	getLogger(Object ctgr) Gets IgniteLogger wrapper around log4j logger for the given category.
UUID	getNodeId()
void	info(String msg)
static boolean	isConfigured() Checks if Log4j is already configured within this VM or not.
boolean	isDebugEnabled()
boolean	isInfoEnabled()
boolean	isQuiet()
boolean	isTraceEnabled()
static Collection<String>	logFiles() Gets files for all registered file appenders.
static void	removeAppender(org.apache.log4j.FileAppender a) Removes file appender.
void	setLevel(org.apache.log4j.Level level) Sets level for internal log4j implementation.
void	setNodeId(UUID nodeId)
String	toString()
void	trace(String msg)
void	updateFilePath(IgniteClosure<String,String> filePathClos) Sets closure that later evaluate file path.
void	warning(String msg)
void	warning(String msg, Throwable e)

Methods inherited from class java.lang.Object

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

Constructor Detail

Log4JLogger

public Log4JLogger()

Creates new logger and automatically detects if root logger already has appenders configured. If it does not, the root logger will be configured with default appender (analogous to calling Log4JLogger(boolean) with parameter true, otherwise, existing appenders will be used (analogous to calling Log4JLogger(boolean) with parameter false).

Log4JLogger

public Log4JLogger(boolean init)

Creates new logger. If initialize parameter is true the Log4j logger will be initialized with default console appender and INFO log level.

Parameters:

init - If true, then a default console appender with following pattern layout will be created: %d{ABSOLUTE} %-5p [%c{1}] %m%n. If false, then no implicit initialization will take place, and Log4j should be configured prior to calling this constructor.

Log4JLogger

public Log4JLogger(org.apache.log4j.Logger impl)

Creates new logger with given implementation.

Parameters:

impl - Log4j implementation to use.

Log4JLogger

public Log4JLogger(String path)
            throws IgniteCheckedException

Creates new logger with given configuration path.

Parameters:

path - Path to log4j configuration XML file.

Throws:

IgniteCheckedException - Thrown in case logger can't be created.

Log4JLogger

public Log4JLogger(File cfgFile)
            throws IgniteCheckedException

Creates new logger with given configuration cfgFile.

Parameters:

cfgFile - Log4j configuration XML file.

Throws:

IgniteCheckedException - Thrown in case logger can't be created.

Log4JLogger

public Log4JLogger(URL cfgUrl)
            throws IgniteCheckedException

Creates new logger with given configuration cfgUrl.

Parameters:

cfgUrl - URL for Log4j configuration XML file.

Throws:

IgniteCheckedException - Thrown in case logger can't be created.

Method Detail

isConfigured

public static boolean isConfigured()

Checks if Log4j is already configured within this VM or not.

Returns:

True if log4j was already configured, false otherwise.

setLevel

public void setLevel(org.apache.log4j.Level level)

Sets level for internal log4j implementation.

Parameters:

level - Log level to set.

fileName

@Nullable
public String fileName()

Specified by:

fileName in interface IgniteLogger

addAppender

public static void addAppender(org.apache.log4j.FileAppender a)

Adds file appender.

Parameters:

a - Appender.

removeAppender

public static void removeAppender(org.apache.log4j.FileAppender a)

Removes file appender.

Parameters:

a - Appender.

setNodeId

public void setNodeId(UUID nodeId)

Specified by:

setNodeId in interface LoggerNodeIdAware

getNodeId

public UUID getNodeId()

Specified by:

getNodeId in interface LoggerNodeIdAware

logFiles

public static Collection<String> logFiles()

Gets files for all registered file appenders.

Returns:

List of files.

getLogger

public Log4JLogger getLogger(Object ctgr)

Gets IgniteLogger wrapper around log4j logger for the given category. If category is null, then root logger is returned. If category is an instance of Class then (Class)ctgr).getName() is used as category name.

Specified by:

getLogger in interface IgniteLogger

Parameters:

ctgr -

Returns:

IgniteLogger wrapper around log4j logger.

trace

public void trace(String msg)

Specified by:

trace in interface IgniteLogger

debug

public void debug(String msg)

Specified by:

debug in interface IgniteLogger

info

public void info(String msg)

Specified by:

info in interface IgniteLogger

warning

public void warning(String msg)

Specified by:

warning in interface IgniteLogger

warning

public void warning(String msg,
           @Nullable
           Throwable e)

Specified by:

warning in interface IgniteLogger

error

public void error(String msg)

Specified by:

error in interface IgniteLogger

error

public void error(String msg,
         @Nullable
         Throwable e)

Specified by:

error in interface IgniteLogger

isTraceEnabled

public boolean isTraceEnabled()

Specified by:

isTraceEnabled in interface IgniteLogger

isDebugEnabled

public boolean isDebugEnabled()

Specified by:

isDebugEnabled in interface IgniteLogger

isInfoEnabled

public boolean isInfoEnabled()

Specified by:

isInfoEnabled in interface IgniteLogger

isQuiet

public boolean isQuiet()

Specified by:

isQuiet in interface IgniteLogger

toString

public String toString()

Overrides:

toString in class Object

updateFilePath

public void updateFilePath(IgniteClosure<String,String> filePathClos)

Sets closure that later evaluate file path.

Parameters:

filePathClos - Closure that generates actual file path.