Package net.i2p.util
Class LogManager
java.lang.Object
net.i2p.util.LogManager
- All Implemented Interfaces:
Flushable
public class LogManager extends Object implements Flushable
Manages the logging system, loading (and reloading) the configuration file,
coordinating the log limits, and storing the set of log records pending.
This also fires off a LogWriter thread that pulls pending records off and
writes them where appropriate.
-
Field Summary
Fields Modifier and Type Field Description static char
CLASS
These define the characters in the format line of the config filestatic String
CONFIG_LOCATION_DEFAULT
static String
CONFIG_LOCATION_PROP
static char
DATE
These define the characters in the format line of the config filestatic int
DEFAULT_CONSOLEBUFFERSIZE
static String
DEFAULT_DATEFORMAT
blank means default short date and medium time for the locale - see DateFormatstatic String
DEFAULT_DEFAULTLEVEL
static boolean
DEFAULT_DISPLAYONSCREEN
static String
DEFAULT_FILENAME
static String
DEFAULT_FILESIZE
static String
DEFAULT_FORMAT
static String
DEFAULT_ONSCREENLEVEL
static String
DEFAULT_ROTATIONLIMIT
static String
FILENAME_OVERRIDE_PROP
static char
MESSAGE
These define the characters in the format line of the config filestatic char
PRIORITY
These define the characters in the format line of the config filestatic String
PROP_CONSOLEBUFFERSIZE
static String
PROP_DATEFORMAT
static String
PROP_DEFAULTLEVEL
static String
PROP_DISPLAYONSCREEN
static String
PROP_DISPLAYONSCREENLEVEL
static String
PROP_FILENAME
static String
PROP_FILESIZE
static String
PROP_FORMAT
static String
PROP_RECORD_PREFIX
static String
PROP_ROTATIONLIMIT
static char
THREAD
These define the characters in the format line of the config file -
Constructor Summary
Constructors Constructor Description LogManager(I2PAppContext context)
-
Method Summary
Modifier and Type Method Description (package private) void
addLog(Log log)
If the log already exists, its priority is set here but cannot be changed later, as it becomes an "orphan" not tracked by the manager.(package private) void
addRecord(LogRecord record)
Used by Log to add records to the queue.String
currentFile()
File may not exist or have old logs in it if not opened yetboolean
displayOnScreen()
void
flush()
Flush any pending records to disk.String
getBaseLogfilename()
LogConsoleBuffer
getBuffer()
int
getConsoleBufferSize()
(package private) I2PAppContext
getContext()
Convenience method for LogRecordFormatterSimpleDateFormat
getDateFormat()
Any usage of returned formatter must be synchronized!String
getDateFormatPattern()
String
getDefaultLimit()
int
getDisplayOnScreenLevel()
int
getFileSize()
static int
getFileSize(String size)
Determine how many bytes are in the given formatted string (5m, 60g, 100k, etc) Size may be k, m, or g; a trailing b is ignored.char[]
getFormat()
Properties
getLimits()
Return a mapping of the explicit overrides - path prefix to (text formatted) limit.Log
getLog(Class<?> cls)
Log
getLog(Class<?> cls, String name)
Log
getLog(String name)
List<Log>
getLogs()
now used by ConfigLogingHelper(package private) Queue<LogRecord>
getQueue()
Zero-copy.int
getRotationLimit()
(package private) void
rereadConfig()
Called periodically by the log writer's thread Do not log here, deadlock of LogWriterboolean
saveConfig()
void
setBaseLogfilename(String filenamePattern)
void
setConfig(String filename)
void
setConsoleBufferSize(int numRecords)
Deprecated.unusedboolean
setDateFormat(String format)
Update the date format Do not log here, deadlock of LogWriter via rereadConfig().void
setDefaultLimit(String lim)
void
setDisplayOnScreen(boolean yes)
Deprecated.unusedvoid
setDisplayOnScreenLevel(int level)
Deprecated.unusedvoid
setFileSize(int numBytes)
Update the log file size limitvoid
setFormat(char[] fmt)
void
setLimits(Properties limits)
Update the existing limit overrides(package private) boolean
shouldDropDuplicates()
void
shutdown()
-
Field Details
-
CONFIG_LOCATION_PROP
- See Also:
- Constant Field Values
-
FILENAME_OVERRIDE_PROP
- See Also:
- Constant Field Values
-
CONFIG_LOCATION_DEFAULT
- See Also:
- Constant Field Values
-
DATE
public static final char DATEThese define the characters in the format line of the config file- See Also:
- Constant Field Values
-
CLASS
public static final char CLASSThese define the characters in the format line of the config file- See Also:
- Constant Field Values
-
THREAD
public static final char THREADThese define the characters in the format line of the config file- See Also:
- Constant Field Values
-
PRIORITY
public static final char PRIORITYThese define the characters in the format line of the config file- See Also:
- Constant Field Values
-
MESSAGE
public static final char MESSAGEThese define the characters in the format line of the config file- See Also:
- Constant Field Values
-
PROP_FORMAT
- See Also:
- Constant Field Values
-
PROP_DATEFORMAT
- See Also:
- Constant Field Values
-
PROP_FILENAME
- See Also:
- Constant Field Values
-
PROP_FILESIZE
- See Also:
- Constant Field Values
-
PROP_ROTATIONLIMIT
- See Also:
- Constant Field Values
-
PROP_DISPLAYONSCREEN
- See Also:
- Constant Field Values
-
PROP_CONSOLEBUFFERSIZE
- See Also:
- Constant Field Values
-
PROP_DISPLAYONSCREENLEVEL
- See Also:
- Constant Field Values
-
PROP_DEFAULTLEVEL
- See Also:
- Constant Field Values
-
PROP_RECORD_PREFIX
- See Also:
- Constant Field Values
-
DEFAULT_FORMAT
- See Also:
- Constant Field Values
-
DEFAULT_DATEFORMAT
blank means default short date and medium time for the locale - see DateFormat- See Also:
- Constant Field Values
-
DEFAULT_FILENAME
- See Also:
- Constant Field Values
-
DEFAULT_FILESIZE
- See Also:
- Constant Field Values
-
DEFAULT_DISPLAYONSCREEN
public static final boolean DEFAULT_DISPLAYONSCREEN- See Also:
- Constant Field Values
-
DEFAULT_CONSOLEBUFFERSIZE
public static final int DEFAULT_CONSOLEBUFFERSIZE- See Also:
- Constant Field Values
-
DEFAULT_ROTATIONLIMIT
- See Also:
- Constant Field Values
-
DEFAULT_DEFAULTLEVEL
- See Also:
- Constant Field Values
-
DEFAULT_ONSCREENLEVEL
- See Also:
- Constant Field Values
-
-
Constructor Details
-
Method Details
-
getLog
-
getLog
-
getLog
-
getLogs
now used by ConfigLogingHelper -
addLog
If the log already exists, its priority is set here but cannot be changed later, as it becomes an "orphan" not tracked by the manager. -
getBuffer
-
setDisplayOnScreen
Deprecated.unused -
displayOnScreen
public boolean displayOnScreen() -
getDisplayOnScreenLevel
public int getDisplayOnScreenLevel() -
setDisplayOnScreenLevel
Deprecated.unused -
getConsoleBufferSize
public int getConsoleBufferSize() -
setConsoleBufferSize
Deprecated.unused -
setConfig
-
currentFile
File may not exist or have old logs in it if not opened yet- Returns:
- non-null
-
addRecord
Used by Log to add records to the queue. This is generally nonblocking and unsyncrhonized but may block when under massive logging load as a way of throttling logging threads. -
rereadConfig
void rereadConfig()Called periodically by the log writer's thread Do not log here, deadlock of LogWriter -
shouldDropDuplicates
boolean shouldDropDuplicates()- Since:
- 0.9.3
-
setLimits
Update the existing limit overrides- Parameters:
limits
- mapping of prefix to log level string (not the log #)
-
setDateFormat
Update the date format Do not log here, deadlock of LogWriter via rereadConfig().- Parameters:
format
- null or empty string means use default format for the locale (with a SHORT date and a MEDIUM time - see DateFormat)- Returns:
- true if the format was updated, false if it was invalid
-
setFileSize
public void setFileSize(int numBytes)Update the log file size limit -
getDefaultLimit
-
setDefaultLimit
-
getLimits
Return a mapping of the explicit overrides - path prefix to (text formatted) limit. -
getFileSize
Determine how many bytes are in the given formatted string (5m, 60g, 100k, etc) Size may be k, m, or g; a trailing b is ignored. Upper-case is allowed. Spaces between the number and letter is are allowed. The number may be in floating point. 4096 min, 2 GB max (returns int) -
getBaseLogfilename
-
setBaseLogfilename
-
getFileSize
public int getFileSize() -
getRotationLimit
public int getRotationLimit() -
saveConfig
public boolean saveConfig()- Returns:
- success
-
getQueue
Zero-copy. For the LogWriter- Since:
- 0.8.2
-
getFormat
public char[] getFormat() -
setFormat
public void setFormat(char[] fmt) -
getDateFormat
Any usage of returned formatter must be synchronized! -
getDateFormatPattern
-
flush
public void flush()Flush any pending records to disk. Blocking up to 250 ms. -
shutdown
public void shutdown() -
getContext
I2PAppContext getContext()Convenience method for LogRecordFormatter- Since:
- 0.7.14
-