public class Log4J2Logger extends Object implements IgniteLogger, LoggerNodeIdAndApplicationAware
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.
DEV_ONLY
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 . |
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)
Logs out debug message.
|
void |
debug(@Nullable String marker,
String msg)
Logs out debug message.
|
void |
error(@Nullable String marker,
String msg,
@Nullable Throwable e)
Logs error message with optional exception.
|
void |
error(String msg,
@Nullable Throwable e)
Logs error message with optional exception.
|
@Nullable String |
fileName()
Gets name of the file being logged to if one is configured or
null otherwise. |
Log4J2Logger |
getLogger(Object ctgr)
Gets
IgniteLogger wrapper around log4j logger for the given
category. |
UUID |
getNodeId()
Gets node ID.
|
void |
info(String msg)
Logs out information message.
|
void |
info(@Nullable String marker,
String msg)
Logs out information message.
|
boolean |
isDebugEnabled()
Tests whether
debug level is enabled. |
boolean |
isInfoEnabled()
Tests whether
info level is enabled. |
boolean |
isQuiet()
Tests whether Logger is in "Quiet mode".
|
boolean |
isTraceEnabled()
Tests whether
trace level is enabled. |
void |
setApplicationAndNode(@Nullable String application,
UUID nodeId)
Sets application name and node ID.
|
String |
toString() |
void |
trace(String msg)
Logs out trace message.
|
void |
trace(@Nullable String marker,
String msg)
Logs out trace message.
|
void |
warning(@Nullable String marker,
String msg,
@Nullable Throwable e)
Logs out warning message with optional exception.
|
void |
warning(String msg,
@Nullable Throwable e)
Logs out warning message with optional exception.
|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
error, warning
setNodeId
public Log4J2Logger()
public Log4J2Logger(String path) throws IgniteCheckedException
path
.path
- Path to log4j2 configuration XML file.IgniteCheckedException
- Thrown in case logger can't be created.public Log4J2Logger(File cfgFile) throws IgniteCheckedException
cfgFile
.cfgFile
- Log4j configuration XML file.IgniteCheckedException
- Thrown in case logger can't be created.public Log4J2Logger(URL cfgUrl) throws IgniteCheckedException
cfgUrl
.cfgUrl
- URL for Log4j configuration XML file.IgniteCheckedException
- Thrown in case logger can't be created.@Nullable public @Nullable String fileName()
null
otherwise.fileName
in interface IgniteLogger
null
otherwise.public org.apache.logging.log4j.core.Logger createConsoleLogger()
public void setApplicationAndNode(@Nullable @Nullable String application, UUID nodeId)
setApplicationAndNode
in interface LoggerNodeIdAndApplicationAware
application
- Application.nodeId
- Node ID.public UUID getNodeId()
getNodeId
in interface LoggerNodeIdAware
public Log4J2Logger getLogger(Object ctgr)
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.getLogger
in interface IgniteLogger
ctgr
- Category for new logger.IgniteLogger
wrapper around log4j logger.public void trace(String msg)
trace
in interface IgniteLogger
msg
- Trace message.public void trace(@Nullable @Nullable String marker, String msg)
this.trace(msg)
.trace
in interface IgniteLogger
marker
- Name of the marker to be associated with the message.msg
- Trace message.public void debug(String msg)
debug
in interface IgniteLogger
msg
- Debug message.public void debug(@Nullable @Nullable String marker, String msg)
this.debug(msg)
.debug
in interface IgniteLogger
marker
- Name of the marker to be associated with the message.msg
- Debug message.public void info(String msg)
info
in interface IgniteLogger
msg
- Information message.public void info(@Nullable @Nullable String marker, String msg)
this.info(msg)
.info
in interface IgniteLogger
marker
- Name of the marker to be associated with the message.msg
- Information message.public void warning(String msg, @Nullable @Nullable Throwable e)
warning
in interface IgniteLogger
msg
- Warning message.e
- Optional exception (can be null
).public void warning(@Nullable @Nullable String marker, String msg, @Nullable @Nullable Throwable e)
this.warning(msg)
.warning
in interface IgniteLogger
marker
- Name of the marker to be associated with the message.msg
- Warning message.e
- Optional exception (can be null
).public void error(String msg, @Nullable @Nullable Throwable e)
error
in interface IgniteLogger
msg
- Error message.e
- Optional exception (can be null
).public void error(@Nullable @Nullable String marker, String msg, @Nullable @Nullable Throwable e)
this.error(msg)
.error
in interface IgniteLogger
marker
- Name of the marker to be associated with the message.msg
- Error message.e
- Optional exception (can be null
).public boolean isTraceEnabled()
trace
level is enabled.isTraceEnabled
in interface IgniteLogger
true
in case when trace
level is enabled, false
otherwise.public boolean isDebugEnabled()
debug
level is enabled.isDebugEnabled
in interface IgniteLogger
true
in case when debug
level is enabled, false
otherwise.public boolean isInfoEnabled()
info
level is enabled.isInfoEnabled
in interface IgniteLogger
true
in case when info
level is enabled, false
otherwise.public boolean isQuiet()
isQuiet
in interface IgniteLogger
true
"Quiet mode" is enabled, false
otherwise
GridGain In-Memory Computing Platform : ver. 8.9.14 Release Date : November 5 2024