org.apache.ignite.logger.log4j2

Class Log4J2Logger

java.lang.Object

org.apache.ignite.logger.log4j2.Log4J2Logger

All Implemented Interfaces:

IgniteLogger, LoggerNodeIdAndApplicationAware, LoggerNodeIdAware

public class Log4J2Logger
extends Object
implements IgniteLogger, LoggerNodeIdAndApplicationAware

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

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

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

and from your code:

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

Please take a look at Apache Log4j 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.

Field Summary

Fields inherited from interface org.apache.ignite.IgniteLogger

DEV_ONLY

Constructor Summary

Constructors

Constructor and Description
Log4J2Logger() Creates new logger with default implementation.
Log4J2Logger(File cfgFile) Creates new logger with given configuration cfgFile.
Log4J2Logger(String path) Creates new logger with given configuration path.
Log4J2Logger(URL cfgUrl) Creates new logger with given configuration cfgUrl.

Method Summary

Modifier and Type	Method and Description
org.apache.logging.log4j.core.Logger	createConsoleLogger() Creates console appender with some reasonable default logging settings.
void	debug(String msg)
void	debug(@Nullable String marker, String msg)
void	error(@Nullable String marker, String msg, @Nullable Throwable e)
void	error(String msg, @Nullable Throwable e)
@Nullable String	fileName()
Log4J2Logger	getLogger(Object ctgr) Gets IgniteLogger wrapper around log4j logger for the given category.
UUID	getNodeId()
void	info(String msg)
void	info(@Nullable String marker, String msg)
boolean	isDebugEnabled()
boolean	isInfoEnabled()
boolean	isQuiet()
boolean	isTraceEnabled()
void	setApplicationAndNode(@Nullable String application, UUID nodeId)
String	toString()
void	trace(String msg)
void	trace(@Nullable String marker, String msg)
void	warning(@Nullable String marker, String msg, @Nullable Throwable e)
void	warning(String msg, @Nullable Throwable e)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.ignite.IgniteLogger

error, warning

Methods inherited from interface org.apache.ignite.logger.LoggerNodeIdAndApplicationAware

setNodeId

Constructor Detail

Log4J2Logger

public Log4J2Logger()

Creates new logger with default implementation.

Log4J2Logger

public Log4J2Logger(String path)
             throws IgniteCheckedException

Creates new logger with given configuration path.

Parameters:

path - Path to log4j2 configuration XML file.

Throws:

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

Log4J2Logger

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

Log4J2Logger

public Log4J2Logger(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

fileName

@Nullable
public @Nullable String fileName()

Specified by:

fileName in interface IgniteLogger

createConsoleLogger

public org.apache.logging.log4j.core.Logger createConsoleLogger()

Creates console appender with some reasonable default logging settings.

Returns:

Logger with auto configured console appender.

setApplicationAndNode

public void setApplicationAndNode(@Nullable
                                  @Nullable String application,
                                  UUID nodeId)

Specified by:

setApplicationAndNode in interface LoggerNodeIdAndApplicationAware

getNodeId

public UUID getNodeId()

Specified by:

getNodeId in interface LoggerNodeIdAware

getLogger

public Log4J2Logger 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

trace

public void trace(@Nullable
                  @Nullable String marker,
                  String msg)

Specified by:

trace in interface IgniteLogger

debug

public void debug(String msg)

Specified by:

debug in interface IgniteLogger

debug

public void debug(@Nullable
                  @Nullable String marker,
                  String msg)

Specified by:

debug in interface IgniteLogger

info

public void info(String msg)

Specified by:

info in interface IgniteLogger

info

public void info(@Nullable
                 @Nullable String marker,
                 String msg)

Specified by:

info in interface IgniteLogger

warning

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

Specified by:

warning in interface IgniteLogger

warning

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

Specified by:

warning in interface IgniteLogger

error

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

Specified by:

error in interface IgniteLogger

error

public void error(@Nullable
                  @Nullable String marker,
                  String msg,
                  @Nullable
                  @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