LogManager (Javadocs [I2P+ 2.13.0+]

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. As of 0.9.41, this class may be overridden via I2PAppContext.setLogManager()

Field Summary

Fields
Modifier and Type	Field and Description
`static char`	`CLASS` CLASS.
`static String`	`CONFIG_LOCATION_DEFAULT` Default logger config file name
`static String`	`CONFIG_LOCATION_PROP` Property name for the logger config file location
`static char`	`DATE` These define the characters in the format line of the config file
`static int`	`DEFAULT_CONSOLEBUFFERSIZE` Default number of entries in the console buffer
`static String`	`DEFAULT_DATEFORMAT` DEFAULT_DATEFORMAT.
`static String`	`DEFAULT_DEFAULTLEVEL` Default log level string
`static boolean`	`DEFAULT_DISPLAYONSCREEN` Default setting for on-screen log display
`static String`	`DEFAULT_FILENAME` Default log file name pattern
`static String`	`DEFAULT_FILESIZE` Default log file size limit as a string
`static String`	`DEFAULT_FORMAT` Default log record format string
`static String`	`DEFAULT_ONSCREENLEVEL` Default on-screen log level string
`static String`	`DEFAULT_ROTATIONLIMIT` Default log rotation limit
`static String`	`FILENAME_OVERRIDE_PROP` Property name to override the log filename
`static char`	`MESSAGE` MESSAGE.
`static char`	`PRIORITY` PRIORITY.
`static String`	`PROP_CONSOLEBUFFERSIZE` Property name for the console buffer size
`static String`	`PROP_DATEFORMAT` Property name for the date format pattern
`static String`	`PROP_DEFAULTLEVEL` Property name for the default log level
`static String`	`PROP_DISPLAYONSCREEN` Property name to enable or disable on-screen display
`static String`	`PROP_DISPLAYONSCREENLEVEL` Property name for the minimum log level displayed on screen
`static String`	`PROP_FILENAME` Property name for the log file name pattern
`static String`	`PROP_FILESIZE` Property name for the log file size limit
`static String`	`PROP_FORMAT` Property name for the log record format string
`static String`	`PROP_RECORD_PREFIX` Prefix for per-logger level override properties
`static String`	`PROP_ROTATIONLIMIT` Property name for the log rotation limit
`static char`	`THREAD` THREAD.

Constructor Summary
Constructors
Constructor and Description
LogManager(I2PAppContext context)

Constructors
Constructor and Description
`LogManager(I2PAppContext context)`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and 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 yet
`boolean`	`displayOnScreen()` Whether log messages should be printed to stdout.
`void`	`flush()` Flush any pending records to disk.
`String`	`getBaseLogfilename()`
`LogConsoleBuffer`	`getBuffer()` Return the circular buffer holding recent log records for console display.
`int`	`getConsoleBufferSize()` Maximum number of entries held in the console buffer.
`(package private) I2PAppContext`	`getContext()` Convenience method for LogRecordFormatter
`SimpleDateFormat`	`getDateFormat()` Any usage of returned formatter must be synchronized!
`String`	`getDateFormatPattern()`
`String`	`getDefaultLimit()`
`int`	`getDisplayOnScreenLevel()` Minimum log level for messages printed to stdout.
`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()` Return all currently cached Log instances.
`(package private) long`	`getMinGzipSize()` Get the minimum size for gzip compression.
`(package private) Queue<LogRecord>`	`getQueue()` Zero-copy.
`int`	`getRotationLimit()`
`(package private) void`	`rereadConfig()` Called periodically by the LogWriter thread to reload the config file.
`boolean`	`saveConfig()` Save the current logging configuration to disk.
`void`	`setBaseLogfilename(String filenamePattern)`
`void`	`setConfig(String filename)` Set the logger config file path and reload configuration.
`boolean`	`setDateFormat(String format)` Update the date format Do not log here, deadlock of LogWriter via rereadConfig().
`void`	`setDefaultLimit(String lim)`
`void`	`setFileSize(int numBytes)` Update the log file size limit
`void`	`setFormat(char[] fmt)`
`void`	`setGzip(boolean yes)` Enable or disable gzip compression for rotated log files.
`void`	`setLimits(Properties limits)` Update the existing limit overrides
`(package private) boolean`	`shouldDropDuplicates()` Whether duplicate log records should be dropped.
`boolean`	`shouldGzip()` Check if gzip compression should be used for rotated log files.
`void`	`shutdown()` Shut down the log manager, flushing and stopping the writer.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - CLASS
```
public static final char CLASS
```
    CLASS.
    See Also:
    Constant Field Values
  - CONFIG_LOCATION_DEFAULT
```
public static final String CONFIG_LOCATION_DEFAULT
```
    Default logger config file name
    See Also:
    Constant Field Values
  - CONFIG_LOCATION_PROP
```
public static final String CONFIG_LOCATION_PROP
```
    Property name for the logger config file location
    See Also:
    Constant Field Values
  - DATE
```
public static final char DATE
```
    These define the characters in the format line of the config file
    See Also:
    Constant Field Values
  - DEFAULT_CONSOLEBUFFERSIZE
```
public static final int DEFAULT_CONSOLEBUFFERSIZE
```
    Default number of entries in the console buffer
    See Also:
    Constant Field Values
  - DEFAULT_DATEFORMAT
```
public static final String DEFAULT_DATEFORMAT
```
    DEFAULT_DATEFORMAT.
    See Also:
    Constant Field Values
  - DEFAULT_DEFAULTLEVEL
```
public static final String DEFAULT_DEFAULTLEVEL
```
    Default log level string
    See Also:
    Constant Field Values
  - DEFAULT_DISPLAYONSCREEN
```
public static final boolean DEFAULT_DISPLAYONSCREEN
```
    Default setting for on-screen log display
    See Also:
    Constant Field Values
  - DEFAULT_FILENAME
```
public static final String DEFAULT_FILENAME
```
    Default log file name pattern
    See Also:
    Constant Field Values
  - DEFAULT_FILESIZE
```
public static final String DEFAULT_FILESIZE
```
    Default log file size limit as a string
    See Also:
    Constant Field Values
  - DEFAULT_FORMAT
```
public static final String DEFAULT_FORMAT
```
    Default log record format string
    See Also:
    Constant Field Values
  - DEFAULT_ONSCREENLEVEL
```
public static final String DEFAULT_ONSCREENLEVEL
```
    Default on-screen log level string
    See Also:
    Constant Field Values
  - DEFAULT_ROTATIONLIMIT
```
public static final String DEFAULT_ROTATIONLIMIT
```
    Default log rotation limit
    See Also:
    Constant Field Values
  - FILENAME_OVERRIDE_PROP
```
public static final String FILENAME_OVERRIDE_PROP
```
    Property name to override the log filename
    See Also:
    Constant Field Values
  - MESSAGE
```
public static final char MESSAGE
```
    MESSAGE.
    See Also:
    Constant Field Values
  - PRIORITY
```
public static final char PRIORITY
```
    PRIORITY.
    See Also:
    Constant Field Values
  - PROP_CONSOLEBUFFERSIZE
```
public static final String PROP_CONSOLEBUFFERSIZE
```
    Property name for the console buffer size
    See Also:
    Constant Field Values
  - PROP_DATEFORMAT
```
public static final String PROP_DATEFORMAT
```
    Property name for the date format pattern
    See Also:
    Constant Field Values
  - PROP_DEFAULTLEVEL
```
public static final String PROP_DEFAULTLEVEL
```
    Property name for the default log level
    See Also:
    Constant Field Values
  - PROP_DISPLAYONSCREEN
```
public static final String PROP_DISPLAYONSCREEN
```
    Property name to enable or disable on-screen display
    See Also:
    Constant Field Values
  - PROP_DISPLAYONSCREENLEVEL
```
public static final String PROP_DISPLAYONSCREENLEVEL
```
    Property name for the minimum log level displayed on screen
    See Also:
    Constant Field Values
  - PROP_FILENAME
```
public static final String PROP_FILENAME
```
    Property name for the log file name pattern
    See Also:
    Constant Field Values
  - PROP_FILESIZE
```
public static final String PROP_FILESIZE
```
    Property name for the log file size limit
    See Also:
    Constant Field Values
  - PROP_FORMAT
```
public static final String PROP_FORMAT
```
    Property name for the log record format string
    See Also:
    Constant Field Values
  - PROP_RECORD_PREFIX
```
public static final String PROP_RECORD_PREFIX
```
    Prefix for per-logger level override properties
    See Also:
    Constant Field Values
  - PROP_ROTATIONLIMIT
```
public static final String PROP_ROTATIONLIMIT
```
    Property name for the log rotation limit
    See Also:
    Constant Field Values
  - THREAD
```
public static final char THREAD
```
    THREAD.
    See Also:
    Constant Field Values
- Constructor Detail
  - LogManager
```
public LogManager(I2PAppContext context)
```
    Parameters:
    context - the I2P app context
- Method Detail
  - addLog
```
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.
    Parameters:
    log - the Log to add and track
  - addRecord
```
void addRecord(LogRecord record)
```
    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.
    Parameters:
    record - the log record to enqueue
  - currentFile
```
public String currentFile()
```
    File may not exist or have old logs in it if not opened yet
    Returns:
    non-null
  - displayOnScreen
```
public boolean displayOnScreen()
```
    Whether log messages should be printed to stdout.
    Returns:
    whether to display log on screen
  - flush
```
public void flush()
```
    Flush any pending records to disk. Blocking up to 250 ms.
    Specified by:
    flush in interface Flushable
  - getBaseLogfilename
```
public String getBaseLogfilename()
```
    Returns:
    the base log filename pattern
  - getBuffer
```
public LogConsoleBuffer getBuffer()
```
    Return the circular buffer holding recent log records for console display.
    Returns:
    the console buffer
  - getConsoleBufferSize
```
public int getConsoleBufferSize()
```
    Maximum number of entries held in the console buffer.
    Returns:
    the console buffer size
  - getContext
```
I2PAppContext getContext()
```
    Convenience method for LogRecordFormatter
  - getDateFormat
```
public SimpleDateFormat getDateFormat()
```
    Any usage of returned formatter must be synchronized!
    Returns:
    the date format
  - getDateFormatPattern
```
public String getDateFormatPattern()
```
    Returns:
    the date format pattern string
  - getDefaultLimit
```
public String getDefaultLimit()
```
    Returns:
    the default log limit as a string
  - getDisplayOnScreenLevel
```
public int getDisplayOnScreenLevel()
```
    Minimum log level for messages printed to stdout.
    Returns:
    the minimum level for on-screen display
  - getFileSize
```
public int getFileSize()
```
    Returns:
    the maximum log file size in bytes
  - getFileSize
```
public 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. Upper-case is allowed. Spaces between the number and letter is are allowed. The number may be in floating point. 16K min, 2 GB max (returns int)
    Returns:
    the file size
  - getFormat
```
public char[] getFormat()
```
    Returns:
    the log format characters
  - getLimits
```
public Properties getLimits()
```
    Return a mapping of the explicit overrides - path prefix to (text formatted) limit.
    Returns:
    the limits
  - getLog
```
public final Log getLog(Class<?> cls)
```
    Parameters:
    cls - the class to get the log for
    Returns:
    the log
  - getLog
```
public final Log getLog(Class<?> cls,
                        String name)
```
    Parameters:
    cls - the class (may be null)
    name - the name
    Returns:
    the log
  - getLog
```
public final Log getLog(String name)
```
    Parameters:
    name - the name
    Returns:
    the log
  - getLogs
```
public List<Log> getLogs()
```
    Return all currently cached Log instances. Now used by ConfigLogingHelper.
    Returns:
    list of all Log objects tracked by this manager
  - getMinGzipSize
```
long getMinGzipSize()
```
    Get the minimum size for gzip compression.
    Returns:
    the minimum size in bytes, or Long.MAX_VALUE if gzip is disabled
  - getQueue
```
Queue<LogRecord> getQueue()
```
    Zero-copy. For the LogWriter
  - getRotationLimit
```
public int getRotationLimit()
```
    Returns:
    the rotation limit (number of log files to keep)
  - rereadConfig
```
void rereadConfig()
```
    Called periodically by the LogWriter thread to reload the config file. Do not log here, deadlock of LogWriter.
  - saveConfig
```
public boolean saveConfig()
```
    Save the current logging configuration to disk.
    Returns:
    true if the configuration was saved successfully
  - setBaseLogfilename
```
public void setBaseLogfilename(String filenamePattern)
```
    Parameters:
    filenamePattern - the base log filename pattern
  - setConfig
```
public final void setConfig(String filename)
```
    Set the logger config file path and reload configuration.
    Parameters:
    filename - the config file path
  - setDateFormat
```
public boolean setDateFormat(String format)
```
    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
  - setDefaultLimit
```
public void setDefaultLimit(String lim)
```
    Parameters:
    lim - the default log limit string
  - setFileSize
```
public void setFileSize(int numBytes)
```
    Update the log file size limit
  - setFormat
```
public void setFormat(char[] fmt)
```
    Parameters:
    fmt - the log format characters
  - setGzip
```
public void setGzip(boolean yes)
```
    Enable or disable gzip compression for rotated log files.
    Parameters:
    yes - true to enable gzip compression
  - setLimits
```
public void setLimits(Properties limits)
```
    Update the existing limit overrides
    Parameters:
    limits - mapping of prefix to log level string (not the log #)
  - shouldDropDuplicates
```
boolean shouldDropDuplicates()
```
    Whether duplicate log records should be dropped.
    Returns:
    true if duplicate records are dropped
  - shouldGzip
```
public boolean shouldGzip()
```
    Check if gzip compression should be used for rotated log files.
    Returns:
    whether gzip
  - shutdown
```
public void shutdown()
```
    Shut down the log manager, flushing and stopping the writer.

Class LogManager

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

CLASS

CONFIG_LOCATION_DEFAULT

CONFIG_LOCATION_PROP

DATE

DEFAULT_CONSOLEBUFFERSIZE

DEFAULT_DATEFORMAT

DEFAULT_DEFAULTLEVEL

DEFAULT_DISPLAYONSCREEN

DEFAULT_FILENAME

DEFAULT_FILESIZE

DEFAULT_FORMAT

DEFAULT_ONSCREENLEVEL

DEFAULT_ROTATIONLIMIT

FILENAME_OVERRIDE_PROP

MESSAGE

PRIORITY

PROP_CONSOLEBUFFERSIZE

PROP_DATEFORMAT

PROP_DEFAULTLEVEL

PROP_DISPLAYONSCREEN

PROP_DISPLAYONSCREENLEVEL

PROP_FILENAME

PROP_FILESIZE

PROP_FORMAT

PROP_RECORD_PREFIX

PROP_ROTATIONLIMIT

THREAD

Constructor Detail

LogManager

Method Detail

addLog

addRecord

currentFile

displayOnScreen

flush

getBaseLogfilename

getBuffer

getConsoleBufferSize

getContext

getDateFormat

getDateFormatPattern

getDefaultLimit

getDisplayOnScreenLevel

getFileSize

getFileSize

getFormat

getLimits

getLog

getLog

getLog

getLogs

getMinGzipSize

getQueue

getRotationLimit

rereadConfig

saveConfig

setBaseLogfilename

setConfig

setDateFormat

setDefaultLimit

setFileSize

setFormat

setGzip

setLimits

shouldDropDuplicates

shouldGzip

shutdown