org.gridgain.grid.logger.log4j

Class GridLog4jLogger

java.lang.Object

org.gridgain.grid.util.lang.GridMetadataAwareAdapter

org.gridgain.grid.logger.log4j.GridLog4jLogger

All Implemented Interfaces:

Serializable, org.gridgain.grid.GridMetadataAware, org.gridgain.grid.logger.GridLogger, org.gridgain.grid.logger.GridLoggerNodeIdAware

public class GridLog4jLogger
extends org.gridgain.grid.util.lang.GridMetadataAwareAdapter
implements org.gridgain.grid.logger.GridLogger, org.gridgain.grid.logger.GridLoggerNodeIdAware

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 GridGain configuration file:

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

and from your code:

      GridConfiguration cfg = new GridConfiguration();
      ...
      URL xml = U.resolveGridGainUrl("config/custom-log4j.xml");
      GridLogger log = new GridLog4jLogger(xml);
      ...
      cfg.setGridLogger(log);
 

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

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

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
GridLog4jLogger() Creates new logger and automatically detects if root logger already has appenders configured.
GridLog4jLogger(boolean init) Creates new logger.
GridLog4jLogger(File cfgFile) Creates new logger with given configuration cfgFile.
GridLog4jLogger(org.apache.log4j.Logger impl) Creates new logger with given implementation.
GridLog4jLogger(String path) Creates new logger with given configuration path.
GridLog4jLogger(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()
GridLog4jLogger	getLogger(Object ctgr) Gets GridLogger 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(org.gridgain.grid.lang.GridClosure<String,String> filePathClos) Sets closure that later evaluate file path.
void	warning(String msg)
void	warning(String msg, Throwable e)

Methods inherited from class org.gridgain.grid.util.lang.GridMetadataAwareAdapter

addMeta, addMetaIfAbsent, addMetaIfAbsent, allMeta, clone, copyMeta, copyMeta, hasMeta, hasMeta, meta, putMetaIfAbsent, putMetaIfAbsent, readExternalMeta, removeMeta, removeMeta, replaceMeta, writeExternalMeta

Methods inherited from class java.lang.Object

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

Constructor Detail

GridLog4jLogger

public GridLog4jLogger()

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 GridLog4jLogger(boolean) with parameter true, otherwise, existing appenders will be used (analogous to calling GridLog4jLogger(boolean) with parameter false).

GridLog4jLogger

public GridLog4jLogger(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.

GridLog4jLogger

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

Creates new logger with given implementation.

Parameters:

impl - Log4j implementation to use.

GridLog4jLogger

public GridLog4jLogger(String path)
                throws org.gridgain.grid.GridException

Creates new logger with given configuration path.

Parameters:

path - Path to log4j configuration XML file.

Throws:

org.gridgain.grid.GridException - Thrown in case logger can't be created.

GridLog4jLogger

public GridLog4jLogger(File cfgFile)
                throws org.gridgain.grid.GridException

Creates new logger with given configuration cfgFile.

Parameters:

cfgFile - Log4j configuration XML file.

Throws:

org.gridgain.grid.GridException - Thrown in case logger can't be created.

GridLog4jLogger

public GridLog4jLogger(URL cfgUrl)
                throws org.gridgain.grid.GridException

Creates new logger with given configuration cfgUrl.

Parameters:

cfgUrl - URL for Log4j configuration XML file.

Throws:

org.gridgain.grid.GridException - 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 org.gridgain.grid.logger.GridLogger

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 org.gridgain.grid.logger.GridLoggerNodeIdAware

getNodeId

public UUID getNodeId()

Specified by:

getNodeId in interface org.gridgain.grid.logger.GridLoggerNodeIdAware

logFiles

public static Collection<String> logFiles()

Gets files for all registered file appenders.

Returns:

List of files.

getLogger

public GridLog4jLogger getLogger(Object ctgr)

Gets GridLogger 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 org.gridgain.grid.logger.GridLogger

Parameters:

ctgr -

Returns:

GridLogger wrapper around log4j logger.

trace

public void trace(String msg)

Specified by:

trace in interface org.gridgain.grid.logger.GridLogger

debug

public void debug(String msg)

Specified by:

debug in interface org.gridgain.grid.logger.GridLogger

info

public void info(String msg)

Specified by:

info in interface org.gridgain.grid.logger.GridLogger

warning

public void warning(String msg)

Specified by:

warning in interface org.gridgain.grid.logger.GridLogger

warning

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

Specified by:

warning in interface org.gridgain.grid.logger.GridLogger

error

public void error(String msg)

Specified by:

error in interface org.gridgain.grid.logger.GridLogger

error

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

Specified by:

error in interface org.gridgain.grid.logger.GridLogger

isTraceEnabled

public boolean isTraceEnabled()

Specified by:

isTraceEnabled in interface org.gridgain.grid.logger.GridLogger

isDebugEnabled

public boolean isDebugEnabled()

Specified by:

isDebugEnabled in interface org.gridgain.grid.logger.GridLogger

isInfoEnabled

public boolean isInfoEnabled()

Specified by:

isInfoEnabled in interface org.gridgain.grid.logger.GridLogger

isQuiet

public boolean isQuiet()

Specified by:

isQuiet in interface org.gridgain.grid.logger.GridLogger

toString

public String toString()

Overrides:

toString in class Object

updateFilePath

public void updateFilePath(org.gridgain.grid.lang.GridClosure<String,String> filePathClos)

Sets closure that later evaluate file path.

Parameters:

filePathClos - Closure that generates actual file path.