@Deprecated public interface LogWriter
Instances of this interface can be obtained by calling DistributedSystem.getLogWriter()
.
For any logged message the log file will contain:
A message always has a level. Logging levels are ordered. Enabling logging at a given level also enables logging at higher levels. The higher the level the more important and urgent the message.
The levels, in descending order, are:
severe
(highest value) is a message level indicating a serious failure. In
general severe
messages should describe events that are of considerable importance
and which will prevent normal program execution. They should be reasonably intelligible to end
users and to information managers.
error
In general error
messages should describe events that are of
considerable importance but will not prevent normal program execution. They should be reasonably
intelligible to end users and to information managers. They are weaker than severe
and stronger than warning
.
warning
is a message level indicating a potential problem. In general
warning
messages should describe events that will be of interest to end users or
information managers, or which indicate potential problems.
info
is a message level for informational messages. Typically info
messages should be reasonably significant and should make sense to end users and system
administrators.
config
is a message level for static configuration messages. config
messages are intended to provide a variety of static configuration information, to assist in
debugging problems that may be associated with particular configurations.
fine
is a message level providing tracing information. In general the
fine
level should be used for information that will be broadly interesting to
developers. This level is for the lowest volume, and most important, tracing messages.
finer
indicates a fairly detailed tracing message. Logging calls for entering,
returning, or throwing an exception are traced at the finer
level.
finest
(lowest value) indicates a highly detailed tracing message. In general
the finest
level should be used for the most voluminous detailed tracing messages.
For each level methods exist that will request a message, at that level, to be logged. These methods are all named after their level.
For each level a method exists that returns a boolean indicating if messages at that level will
currently be logged. The names of these methods are of the form:
levelEnabled
.
Modifier and Type | Method and Description |
---|---|
void |
config(String message)
Deprecated.
Writes a message to this writer.
|
void |
config(String message,
Throwable throwable)
Deprecated.
Writes both a message and exception to this writer.
|
void |
config(Throwable throwable)
Deprecated.
Writes an exception to this writer.
|
boolean |
configEnabled()
Deprecated.
Returns true if "config" log messages are enabled.
|
LogWriterI18n |
convertToLogWriterI18n()
Deprecated.
A mechanism for accessing the abstraction layer used for internationalization.
|
void |
entering(String sourceClass,
String sourceMethod)
Deprecated.
Log a method entry.
|
void |
error(String message)
Deprecated.
Writes a message to this writer.
|
void |
error(String message,
Throwable throwable)
Deprecated.
Writes both a message and exception to this writer.
|
void |
error(Throwable throwable)
Deprecated.
Writes an exception to this writer.
|
boolean |
errorEnabled()
Deprecated.
Returns true if "error" log messages are enabled.
|
void |
exiting(String sourceClass,
String sourceMethod)
Deprecated.
Log a method return.
|
void |
fine(String message)
Deprecated.
Writes a message to this writer.
|
void |
fine(String message,
Throwable throwable)
Deprecated.
Writes both a message and exception to this writer.
|
void |
fine(Throwable throwable)
Deprecated.
Writes an exception to this writer.
|
boolean |
fineEnabled()
Deprecated.
Returns true if "fine" log messages are enabled.
|
void |
finer(String message)
Deprecated.
Writes a message to this writer.
|
void |
finer(String message,
Throwable throwable)
Deprecated.
Writes both a message and exception to this writer.
|
void |
finer(Throwable throwable)
Deprecated.
Writes an exception to this writer.
|
boolean |
finerEnabled()
Deprecated.
Returns true if "finer" log messages are enabled.
|
void |
finest(String message)
Deprecated.
Writes a message to this writer.
|
void |
finest(String message,
Throwable throwable)
Deprecated.
Writes both a message and exception to this writer.
|
void |
finest(Throwable throwable)
Deprecated.
Writes an exception to this writer.
|
boolean |
finestEnabled()
Deprecated.
Returns true if "finest" log messages are enabled.
|
Handler |
getHandler()
Deprecated.
Returns a 1.4 logging handler that can be used to direct application output to this GemFire
logger using the standard JDK logger APIs.
|
void |
info(String message)
Deprecated.
Writes a message to this writer.
|
void |
info(String message,
Throwable throwable)
Deprecated.
Writes both a message and exception to this writer.
|
void |
info(Throwable throwable)
Deprecated.
Writes an exception to this writer.
|
boolean |
infoEnabled()
Deprecated.
Returns true if "info" log messages are enabled.
|
void |
severe(String message)
Deprecated.
Writes a message to this writer.
|
void |
severe(String message,
Throwable throwable)
Deprecated.
Writes both a message and exception to this writer.
|
void |
severe(Throwable throwable)
Deprecated.
Writes an exception to this writer.
|
boolean |
severeEnabled()
Deprecated.
Returns true if "severe" log messages are enabled.
|
void |
throwing(String sourceClass,
String sourceMethod,
Throwable thrown)
Deprecated.
Log throwing an exception.
|
void |
warning(String message)
Deprecated.
Writes a message to this writer.
|
void |
warning(String message,
Throwable throwable)
Deprecated.
Writes both a message and exception to this writer.
|
void |
warning(Throwable throwable)
Deprecated.
Writes an exception to this writer.
|
boolean |
warningEnabled()
Deprecated.
Returns true if "warning" log messages are enabled.
|
boolean severeEnabled()
void severe(String message, Throwable throwable)
void severe(String message)
void severe(Throwable throwable)
boolean errorEnabled()
void error(String message, Throwable throwable)
void error(String message)
void error(Throwable throwable)
boolean warningEnabled()
void warning(String message, Throwable throwable)
void warning(String message)
void warning(Throwable throwable)
boolean infoEnabled()
void info(String message, Throwable throwable)
void info(String message)
void info(Throwable throwable)
boolean configEnabled()
void config(String message, Throwable throwable)
void config(String message)
void config(Throwable throwable)
boolean fineEnabled()
void fine(String message, Throwable throwable)
void fine(String message)
void fine(Throwable throwable)
boolean finerEnabled()
void finer(String message, Throwable throwable)
void finer(String message)
void finer(Throwable throwable)
void entering(String sourceClass, String sourceMethod)
The logging is done using the finer
level. The string message will start with
"ENTRY"
and include the class and method names.
sourceClass
- Name of class that issued the logging request.sourceMethod
- Name of the method that issued the logging request.void exiting(String sourceClass, String sourceMethod)
The logging is done using the finer
level. The string message will start with
"RETURN"
and include the class and method names.
sourceClass
- Name of class that issued the logging request.sourceMethod
- Name of the method that issued the logging request.void throwing(String sourceClass, String sourceMethod, Throwable thrown)
Use to log that a method is terminating by throwing an exception. The logging is done using the
finer
level.
This is a convenience method that could be done instead by calling
finer(String, Throwable)
. The string message will start with "THROW"
and
include the class and method names.
sourceClass
- Name of class that issued the logging request.sourceMethod
- Name of the method that issued the logging request.thrown
- The Throwable that is being thrown.boolean finestEnabled()
void finest(String message, Throwable throwable)
void finest(String message)
void finest(Throwable throwable)
Handler getHandler()
LogWriterI18n convertToLogWriterI18n()