edu.iu.dsc.tws.common.logging

Class LoggingHelper

java.lang.Object

edu.iu.dsc.tws.common.logging.LoggingHelper

public final class LoggingHelper
extends java.lang.Object

A helper class to init corresponding LOGGER setting loggerInit() is required to invoke before any logging

Credits: com.twitter.heron.common.utils.logging.LoggingHelper

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LoggingHelper.LoggingOutputStream An OutputStream that writes contents to a Logger upon each call to flush()
static class	LoggingHelper.StdOutErrLevel

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_FORMAT

Method Summary

Modifier and Type	Method and Description
static void	addLoggingHandler(java.util.logging.Handler handler)
static java.util.logging.FileHandler	getFileHandler(java.lang.String workerId, java.lang.String loggingDir, Config config) Deprecated. Use Twister2FileLogHandler instead
static void	initTwisterFileLogHandler(java.lang.String logFile, java.lang.String logDir, Config config)
static void	loggerInit(boolean isRedirectStdOutErr) Init java util logging with default format
static void	loggerInit(boolean isRedirectStdOutErr, java.lang.String format) Init java util logging
static void	setLoggingFormat(java.lang.String format)
static void	setLogLevel(java.util.logging.Level level)
static void	setupLogging(Config config, java.lang.String logDir, java.lang.String logFile) this method is called to setup logging parameters and file handler

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_FORMAT

public static final java.lang.String DEFAULT_FORMAT

See Also:

Constant Field Values

Method Detail

loggerInit

public static void loggerInit(boolean isRedirectStdOutErr)
                       throws java.io.IOException

Init java util logging with default format

Parameters:

isRedirectStdOutErr - whether we redirect std out&err

Throws:

java.io.IOException

loggerInit

public static void loggerInit(boolean isRedirectStdOutErr,
                              java.lang.String format)
                       throws java.io.IOException

Init java util logging

Parameters:

isRedirectStdOutErr - whether we redirect std out&err

format - the format to log

Throws:

java.io.IOException

setLoggingFormat

public static void setLoggingFormat(java.lang.String format)

addLoggingHandler

public static void addLoggingHandler(java.util.logging.Handler handler)

setLogLevel

public static void setLogLevel(java.util.logging.Level level)

initTwisterFileLogHandler

public static void initTwisterFileLogHandler(java.lang.String logFile,
                                             java.lang.String logDir,
                                             Config config)
                                      throws java.io.IOException

Throws:

java.io.IOException

getFileHandler

@Deprecated
public static java.util.logging.FileHandler getFileHandler(java.lang.String workerId,
                                                                       java.lang.String loggingDir,
                                                                       Config config)
                                                                throws java.io.IOException,
                                                                       java.lang.SecurityException

Deprecated. Use Twister2FileLogHandler instead

Initialize a FileHandler to write to a set of files with optional append. When (approximately) the given limit has been written to one file, another file will be opened. The output will cycle through a set of count files. The pattern of file name should be: ${workerId}.log.index

The FileHandler is configured based on LogManager properties (or their default values) except that the given pattern argument is used as the filename pattern, the file limit is set to the limit argument, and the file count is set to the given count argument, and the append mode is set to the given append argument.

The count must be at least 1.

Throws:

java.io.IOException - if there are IO problems opening the files.

java.lang.SecurityException - if a security manager exists and if the caller does not have LoggingPermission("control").

java.lang.IllegalArgumentException - if limit < 0, or count < 1.

java.lang.IllegalArgumentException - if pattern is an empty string

setupLogging

public static void setupLogging(Config config,
                                java.lang.String logDir,
                                java.lang.String logFile)

this method is called to setup logging parameters and file handler