Package org.apache.ignite.logger.jcl
Class JclLogger
- java.lang.Object
-
- org.apache.ignite.logger.jcl.JclLogger
-
- All Implemented Interfaces:
IgniteLogger
public class JclLogger extends Object implements IgniteLogger
This logger wraps any JCL (Jakarta Commons Logging) loggers. Implementation simply delegates to underlying JCL logger. This logger should be used by loaders that have JCL-based internal logging (e.g., Websphere).Here is an example of configuring JCL logger in Ignite configuration Spring file to work over log4j implementation. Note that we use the same configuration file as we provide by default:
... <property name="gridLogger"> <bean class="org.apache.ignite.logger.jcl.JclLogger"> <constructor-arg type="org.apache.commons.logging.Log"> <bean class="org.apache.commons.logging.impl.Log42JLogger"> <constructor-arg type="java.lang.String" value="config/ignite-log4j.xml"/> </bean> </constructor-arg> </bean> </property> ...If you are using system properties to configure JCL logger use following configuration:... <property name="gridLogger"> <bean class="org.apache.ignite.logger.jcl.JclLogger"/> </property> ...And the same configuration if you'd like to configure Ignite in your code:IgniteConfiguration cfg = new IgniteConfiguration(); ... IgniteLogger log = new JclLogger(new Log4J2Logger("config/ignite-log4j.xml")); ... cfg.setGridLogger(log);or following for the configuration by means of system properties:IgniteConfiguration cfg = new IgniteConfiguration(); ... IgniteLogger log = new JclLogger(); ... cfg.setGridLogger(log);It's recommended to use Ignite logger injection instead of using/instantiating logger in your task/job code. See
LoggerResourceannotation about logger injection.
-
-
Field Summary
-
Fields inherited from interface org.apache.ignite.IgniteLogger
DEV_ONLY
-
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voiddebug(String msg)Logs out debug message.voiderror(String msg)Logs out error message.voiderror(String msg, @Nullable Throwable e)Logs error message with optional exception.@Nullable StringfileName()Gets name of the file being logged to if one is configured ornullotherwise.IgniteLoggergetLogger(Object ctgr)Creates new logger with given category based off the current instance.voidinfo(String msg)Logs out information message.booleanisDebugEnabled()Tests whetherdebuglevel is enabled.booleanisInfoEnabled()Tests whetherinfolevel is enabled.booleanisQuiet()Tests whether Logger is in "Quiet mode".booleanisTraceEnabled()Tests whethertracelevel is enabled.StringtoString()voidtrace(String msg)Logs out trace message.voidwarning(String msg)Logs out warning message.voidwarning(String msg, @Nullable Throwable e)Logs out warning message with optional exception.
-
-
-
Method Detail
-
getLogger
public IgniteLogger getLogger(Object ctgr)
Creates new logger with given category based off the current instance.- Specified by:
getLoggerin interfaceIgniteLogger- Parameters:
ctgr- Category for new logger.- Returns:
- New logger with given category.
-
trace
public void trace(String msg)
Logs out trace message.- Specified by:
tracein interfaceIgniteLogger- Parameters:
msg- Trace message.
-
debug
public void debug(String msg)
Logs out debug message.- Specified by:
debugin interfaceIgniteLogger- Parameters:
msg- Debug message.
-
info
public void info(String msg)
Logs out information message.- Specified by:
infoin interfaceIgniteLogger- Parameters:
msg- Information message.
-
warning
public void warning(String msg)
Logs out warning message.- Specified by:
warningin interfaceIgniteLogger- Parameters:
msg- Warning message.
-
warning
public void warning(String msg, @Nullable @Nullable Throwable e)
Logs out warning message with optional exception.- Specified by:
warningin interfaceIgniteLogger- Parameters:
msg- Warning message.e- Optional exception (can benull).
-
error
public void error(String msg)
Logs out error message.- Specified by:
errorin interfaceIgniteLogger- Parameters:
msg- Error message.
-
isQuiet
public boolean isQuiet()
Tests whether Logger is in "Quiet mode".- Specified by:
isQuietin interfaceIgniteLogger- Returns:
true"Quiet mode" is enabled,falseotherwise
-
error
public void error(String msg, @Nullable @Nullable Throwable e)
Logs error message with optional exception.- Specified by:
errorin interfaceIgniteLogger- Parameters:
msg- Error message.e- Optional exception (can benull).
-
isTraceEnabled
public boolean isTraceEnabled()
Tests whethertracelevel is enabled.- Specified by:
isTraceEnabledin interfaceIgniteLogger- Returns:
truein case whentracelevel is enabled,falseotherwise.
-
isDebugEnabled
public boolean isDebugEnabled()
Tests whetherdebuglevel is enabled.- Specified by:
isDebugEnabledin interfaceIgniteLogger- Returns:
truein case whendebuglevel is enabled,falseotherwise.
-
isInfoEnabled
public boolean isInfoEnabled()
Tests whetherinfolevel is enabled.- Specified by:
isInfoEnabledin interfaceIgniteLogger- Returns:
truein case wheninfolevel is enabled,falseotherwise.
-
fileName
@Nullable public @Nullable String fileName()
Gets name of the file being logged to if one is configured ornullotherwise.- Specified by:
fileNamein interfaceIgniteLogger- Returns:
- Name of the file being logged to if one is configured or
nullotherwise.
-
-