public interface LogWriterI18n
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(StringId msgID)
Writes a message to this writer.
|
void |
config(StringId msgID,
Object param)
Writes a message to this writer.
|
void |
config(StringId msgID,
Object[] params)
Writes a message to this writer.
|
void |
config(StringId msgID,
Object[] params,
Throwable ex)
Writes both a message and exception to this writer.
|
void |
config(StringId msgID,
Object param,
Throwable ex)
Writes both a message and exception to this writer.
|
void |
config(StringId msgID,
Throwable ex)
Writes both a message and exception to this writer.
|
void |
config(Throwable ex)
Writes an exception to this writer.
|
boolean |
configEnabled() |
LogWriter |
convertToLogWriter()
A mechanism for accessing the abstraction layer used for a plain logger.
|
void |
entering(String sourceClass,
String sourceMethod)
Log a method entry.
|
void |
error(StringId msgID)
Writes a message to this writer.
|
void |
error(StringId msgID,
Object param)
Writes a message to this writer.
|
void |
error(StringId msgID,
Object[] params)
Writes a message to this writer.
|
void |
error(StringId msgID,
Object[] params,
Throwable ex)
Writes both a message and exception to this writer.
|
void |
error(StringId msgID,
Object param,
Throwable ex)
Writes both a message and exception to this writer.
|
void |
error(StringId msgID,
Throwable ex)
Writes both a message and exception to this writer.
|
void |
error(Throwable ex)
Writes an exception to this writer.
|
boolean |
errorEnabled() |
void |
exiting(String sourceClass,
String sourceMethod)
Log a method return.
|
void |
fine(String msg)
Writes a message to this writer.
|
void |
fine(String msg,
Throwable ex)
Writes both a message and exception to this writer.
|
void |
fine(Throwable ex)
Writes an exception to this writer.
|
boolean |
fineEnabled() |
void |
finer(String msg)
Writes a message to this writer.
|
void |
finer(String msg,
Throwable ex)
Writes both a message and exception to this writer.
|
void |
finer(Throwable ex)
Writes an exception to this writer.
|
boolean |
finerEnabled() |
void |
finest(String msg)
Writes a message to this writer.
|
void |
finest(String msg,
Throwable ex)
Writes both a message and exception to this writer.
|
void |
finest(Throwable ex)
Writes an exception to this writer.
|
boolean |
finestEnabled() |
Handler |
getHandler()
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(StringId msgID)
Writes a message to this writer.
|
void |
info(StringId msgID,
Object param)
Writes a message to this writer.
|
void |
info(StringId msgID,
Object[] params)
Writes a message to this writer.
|
void |
info(StringId msgID,
Object[] params,
Throwable ex)
Writes both a message and exception to this writer.
|
void |
info(StringId msgID,
Object param,
Throwable ex)
Writes both a message and exception to this writer.
|
void |
info(StringId msgID,
Throwable ex)
Writes both a message and exception to this writer.
|
void |
info(Throwable ex)
Writes an exception to this writer.
|
boolean |
infoEnabled() |
void |
severe(StringId msgID)
Writes a message to this writer.
|
void |
severe(StringId msgID,
Object param)
Writes a message to this writer.
|
void |
severe(StringId msgID,
Object[] params)
Writes a message to this writer.
|
void |
severe(StringId msgID,
Object[] params,
Throwable ex)
Writes both a message and exception to this writer.
|
void |
severe(StringId msgID,
Object param,
Throwable ex)
Writes both a message and exception to this writer.
|
void |
severe(StringId msgID,
Throwable ex)
Writes both a message and exception to this writer.
|
void |
severe(Throwable ex)
Writes an exception to this writer.
|
boolean |
severeEnabled() |
void |
throwing(String sourceClass,
String sourceMethod,
Throwable thrown)
Log throwing an exception.
|
void |
warning(StringId msgID)
Writes a message to this writer.
|
void |
warning(StringId msgID,
Object param)
Writes a message to this writer.
|
void |
warning(StringId msgID,
Object[] params)
Writes a message to this writer.
|
void |
warning(StringId msgID,
Object[] params,
Throwable ex)
Writes both a message and exception to this writer.
|
void |
warning(StringId msgID,
Object param,
Throwable ex)
Writes both a message and exception to this writer.
|
void |
warning(StringId msgID,
Throwable ex)
Writes both a message and exception to this writer.
|
void |
warning(Throwable ex)
Writes an exception to this writer.
|
boolean |
warningEnabled() |
boolean severeEnabled()
void severe(Throwable ex)
void severe(StringId msgID, Object[] params, Throwable ex)
void severe(StringId msgID, Object param, Throwable ex)
void severe(StringId msgID, Throwable ex)
void severe(StringId msgID, Object[] params)
void severe(StringId msgID, Object param)
void severe(StringId msgID)
boolean errorEnabled()
void error(Throwable ex)
void error(StringId msgID, Object[] params, Throwable ex)
void error(StringId msgID, Object param, Throwable ex)
void error(StringId msgID, Throwable ex)
void error(StringId msgID, Object[] params)
void error(StringId msgID, Object param)
void error(StringId msgID)
boolean warningEnabled()
void warning(Throwable ex)
void warning(StringId msgID, Object[] params, Throwable ex)
void warning(StringId msgID, Object param, Throwable ex)
void warning(StringId msgID, Throwable ex)
void warning(StringId msgID, Object[] params)
void warning(StringId msgID, Object param)
void warning(StringId msgID)
boolean infoEnabled()
void info(Throwable ex)
void info(StringId msgID, Object[] params, Throwable ex)
void info(StringId msgID, Object param, Throwable ex)
void info(StringId msgID, Throwable ex)
void info(StringId msgID, Object[] params)
void info(StringId msgID, Object param)
void info(StringId msgID)
boolean configEnabled()
void config(Throwable ex)
void config(StringId msgID, Object[] params, Throwable ex)
void config(StringId msgID, Object param, Throwable ex)
void config(StringId msgID, Throwable ex)
void config(StringId msgID, Object[] params)
void config(StringId msgID, Object param)
void config(StringId msgID)
boolean fineEnabled()
void fine(String msg, Throwable ex)
void fine(String msg)
void fine(Throwable ex)
boolean finerEnabled()
void finer(String msg, Throwable ex)
void finer(String msg)
void finer(Throwable ex)
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 msg, Throwable ex)
void finest(String msg)
void finest(Throwable ex)
Handler getHandler()
LogWriter convertToLogWriter()
Copyright © 1997-2017 Pivotal Software, Inc. All rights reserved.