Package org.apache.ignite.logger.java
Class JavaLogger
- java.lang.Object
-
- org.apache.ignite.logger.java.JavaLogger
-
- All Implemented Interfaces:
IgniteLogger,org.apache.ignite.internal.logger.IgniteLoggerEx
public class JavaLogger extends Object implements org.apache.ignite.internal.logger.IgniteLoggerEx
Logger to use with Java logging. Implementation simply delegates to Java Logging.Here is an example of configuring Java 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.java.JavaLogger"> <constructor-arg type="java.util.logging.Logger"> <bean class="java.util.logging.Logger"> <constructor-arg type="java.lang.String" value="global"/> </bean> </constructor-arg> </bean> </property> ...or... <property name="gridLogger"> <bean class="org.apache.ignite.logger.java.JavaLogger"/> </property> ...And the same configuration if you'd like to configure Ignite in your code:IgniteConfiguration cfg = new IgniteConfiguration(); ... IgniteLogger log = new JavaLogger(Logger.global); ... cfg.setGridLogger(log);or which is actually the same:IgniteConfiguration cfg = new IgniteConfiguration(); ... IgniteLogger log = new JavaLogger(); ... cfg.setGridLogger(log);Please take a look atLoggerjavadoc for additional information.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 Modifier and Type Field Description static StringDFLT_CONFIG_PATH-
Fields inherited from interface org.apache.ignite.IgniteLogger
DEV_ONLY
-
-
Constructor Summary
Constructors Constructor Description JavaLogger()Creates new logger.JavaLogger(boolean init)Creates new logger.JavaLogger(Logger impl, boolean configure)Creates new logger with given implementation.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description voidaddConsoleAppender(boolean clearOutput)Adds console appender to the logger.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.voidflush()Flush any buffered output.IgniteLoggergetLogger(Object ctgr)Creates new logger with given category based off the current instance.voidinfo(String msg)Logs out information message.static booleanisConfigured()Checks if logger is already configured within this VM or not.booleanisDebugEnabled()Tests whetherdebuglevel is enabled.booleanisInfoEnabled()Tests whetherinfolevel is enabled.booleanisQuiet()Tests whether Logger is in "Quiet mode".booleanisTraceEnabled()Tests whethertracelevel is enabled.voidsetApplicationAndNode(@Nullable String application, @Nullable UUID nodeId)Sets application name and node ID.voidsetWorkDirectory(String workDir)Set work directory.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.
-
-
-
Field Detail
-
DFLT_CONFIG_PATH
public static final String DFLT_CONFIG_PATH
- See Also:
- Constant Field Values
-
-
Constructor Detail
-
JavaLogger
public JavaLogger()
Creates new logger.
-
JavaLogger
public JavaLogger(boolean init)
Creates new logger.- Parameters:
init- Iftrue, then a default console appender will be created. Iffalse, then no implicit initialization will take place, and java logger should be configured prior to calling this constructor.
-
JavaLogger
public JavaLogger(Logger impl, boolean configure)
Creates new logger with given implementation.- Parameters:
impl- Java Logging implementation to use.configure- Configure logger.
-
-
Method Detail
-
isConfigured
public static boolean isConfigured()
Checks if logger is already configured within this VM or not.- Returns:
Trueif logger was already configured,falseotherwise.
-
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.
-
addConsoleAppender
public void addConsoleAppender(boolean clearOutput)
Adds console appender to the logger.- Specified by:
addConsoleAppenderin interfaceorg.apache.ignite.internal.logger.IgniteLoggerEx- Parameters:
clearOutput- Iftruethen console output must be configured without any additional info like time, message level, thread info, etc.
-
flush
public void flush()
Flush any buffered output.- Specified by:
flushin interfaceorg.apache.ignite.internal.logger.IgniteLoggerEx
-
setWorkDirectory
public void setWorkDirectory(String workDir)
Set work directory.- Parameters:
workDir- Work directory.
-
setApplicationAndNode
public void setApplicationAndNode(@Nullable @Nullable String application, @Nullable @Nullable UUID nodeId)Sets application name and node ID.- Specified by:
setApplicationAndNodein interfaceorg.apache.ignite.internal.logger.IgniteLoggerEx- Parameters:
application- Application.nodeId- Node ID.
-
-