Table of Contents
- Logging Messages
- The log() Methods
- The logp() Methods
- The logrb() Methods
- The Last Log Methods
- Adding and Removing Handlers
- Setting a Log Filter
- Setting the Log Level
- Parent Logger
- Additional Methods
The java.util.Logger class is the main access point to the Java logging API. Here is how you create a logger:
Logger logger = Logger.getLogger("myLogger");
The string passed as parameter to the getLogger() factory method is the name of the Logger to create. You can choose the name freely, but the name implies where the Logger is located in the Logger hierarchy. Every . (dot) in the name is interpreted as a branch in the hierarchy. Look at these names:
myApp myApp.user myApp.admin myApp.admin.import.user
These names are all valid. They also imply a hierarchy. The name "myApp" is at the top of the hierarchy. The two names "myApp.user" and "myApp.admin" are children of the "myApp" name. The name "myApp.admin.import.user" is a branch of the name "myApp.admin.import", which is again a branch of the "myApp.admin" name.
The Logger hierarchy is explored in more detail in its own text.
You can obtain the name of a Logger using the getName() method, in case you need it. Here is an example:
String name = logger.getName();
It is convention to use the class name of the class creating the Logger, including package name, as name for theLogger. Here is an example:
Logger logger = Logger.getLogger( MyClass.class.getName() );
Logging Messages
To log a message using a Logger, you call one of its many logging methods. Among these are:
log (Level level, String message);
log (Level level, String message, Object param1);
log (Level level, String message, Object[] params);
log (Level level, String message, Throwable t);
log (LogRecord record);
logp (Level level, String sourceClass, String sourceMethod, String msg);
logp (Level level, String sourceClass, String sourceMethod, String msg,
Object param1);
logp (Level level, String sourceClass, String sourceMethod, String msg,
Object[] params);
logp (Level level, String sourceClass, String sourceMethod, String msg,
Throwable t);
logrb(Level level, String sourceClass, String sourceMethod,
String bundle, String msg);
logrb(Level level, String sourceClass, String sourceMethod,
String bundle, String msg, Object param1);
logrb(Level level, String sourceClass, String sourceMethod,
String bundle, String msg, Object[] params);
logrb(Level level, String sourceClass, String sourceMethod,
String bundle, String msg, Throwable t);
entering(String sourceClass, String sourceMethod);
entering(String sourceClass, String sourceMethod, Object param1);
entering(String sourceClass, String sourceMethod, Object[] params);
exiting (String sourceClass, String sourceMethod);
exiting (String sourceClass, String sourceMethod, Object result);
fine (String message);
finer (String message);
finest (String message);
config (String message);
info (String message);
warning (String message);
severe (String message);
throwing(String sourceClass, String sourceMethod, Throwable t);
I am not going to explain every single of these methods in detail. They are explained in the JavaDoc‘s for Java. But, I am going to explain their purpose. Knowing their purpose you can most likely figure out the rest, with help from the JavaDoc.
The log() Methods
The log() group of methods will log a message at a certain log level. The log level is passed as parameter. Use one of the Level constants as parameter. Log level is covered in more detail in its own text.
Some of the log() methods can take object parameters. These object parameters are inserted into the log message, before it is being logged. The merging of object parameters into the message is only performed, if the message is not filtered out, either by a Filter, or because of too low log level. This improves performance in the cases where the message is filtered out.
Here is a log() example:
Logger logger = Logger.getLogger("myLogger");
logger.log(Level.SEVERE, "Hello logging");
And here is what is logged to the console (default log destination) :
08-01-2012 14:10:43 logging.LoggingExamples main SEVERE: Hello logging
Here is an example that inserts a parameter into the message:
logger.log(Level.SEVERE, "Hello logging: {0} ", "P1");
And here is what is being logged:
08-01-2012 14:45:12 logging.LoggingExamples main SEVERE: Hello logging: P1
Notice how the object parameter value P1 is inserted at the place in the log message where the {0} is located. The0 is the index of the object parameter to insert.
Here is an example that logs a message with multiple object parameters to be inserted into the log message:
logger.log(Level.SEVERE, "Hello logging: {0}, {1}",
new Object[] {"P1", "P2"});
Here is what is being logged:
08-01-2012 14:45:12 logging.LoggingExamples main SEVERE: Hello logging: P1, P2
Notice again how the object parameters are inserted into the log message instead of the {0} and {1} tokens. As mentioned earlier, the number inside the token refers to the index of the object parameter to insert, in the object parameter array passed to the log() message.
Here is an example that logs a Throwable:
logger.log(Level.SEVERE, "Hello logging",
new RuntimeException("Error"));
Here is what is being logged (use the scrollbar to see it all):
08-01-2012 14:54:29 logging.LoggingExamples main SEVERE: Hello logging java.lang.RuntimeException: Error at logging.LoggingExamples.main(LoggingExamples.java:18) at sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method) at sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:39) at sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:25) at java.lang.reflect.Method.invoke(Method.java:597) at com.intellij.rt.execution.application.AppMain.main(AppMain.java:120)
The logp() Methods
The logp() methods work like the log() methods, except each method take an extra two parameters: ThesourceClass and sourceMethod parameter.
These two parameters are intended to tell from what class and method the log message originated. In other words, which class and method was the "source" of the log message.
The logrb() Methods
The logrb() methods work like the log() methods too, except they can obtain the log messages from a resource bundle. A resource bundle is a set of texts containing key, value pairs, like a property file. Each file contains the same set of keys, with values in different languages. Resource bundles are an internationalization feature, and I won‘t cover it in great detail here.
Here is a logrb() example:
logger.logrb(Level.SEVERE, "logging.LoggingExamples", "main",
"resources.myresources", "key1");
This example looks up a message in the resource bundle named resources.myresources by the key key1. If the resource bundle does not contain a key with that name (key1), the value itself is logged as a message. In this example then the value "key1" would have been logged as message, if no key named "key1" had existed in the resource bundle.
Here is what has logged:
08-01-2012 17:14:39 logging.LoggingExamples main SEVERE: This is message 1
Here is what the resource bundle (property file) looks like:
key1 : This is message 1 key2 : this is message 2
The Java Doc says nothing about how you localize the messages using a Locale. How to select the language of the ResourceBundle, in other words.
The Last Log Methods
The Logger also has the following methods for logging:
entering(String sourceClass, String sourceMethod); entering(String sourceClass, String sourceMethod, Object param1); entering(String sourceClass, String sourceMethod, Object[] params); exiting (String sourceClass, String sourceMethod); exiting (String sourceClass, String sourceMethod, Object result); fine (String message); finer (String message); finest (String message); config (String message); info (String message); warning (String message); severe (String message);
Each of these methods corresponds to a log level. For instance, finest(), finer(), fine(), info(),warning() and severe() each corresponds to one of the log levels. Logging message using one of these methods corresponds to calling the log() method
Adding and Removing Handlers
You can add Handler‘s to the Logger using the addHandler() method. Here is an example:
Logger logger = Logger.getLogger("myLogger");
logger.addHandler(new ConsoleHandler());
logger.logrb(Level.SEVERE, "logging.LoggingExamples", "main",
"resources.myresources", "key1");
A Logger can have multiple Handler‘s. When logging, messages are forwarded to all Handler‘s.
You can obtain all Handler‘s of a Logger using the getHandlers() method, like this:
Handler[] handlers = logger.getHandlers();
You can remove a Handler using the removeHandler() method. Here is an example:
Logger logger = Logger.getLogger("myLogger");
Handler handler = new ConsoleHandler();
logger.addHandler(handler);
logger.remove(handler)
Setting a Log Filter
You can set filters on a Logger which filters out what LogRecords that gets forwarded to the Handler‘s of theLogger. You set the Filter on a Logger using the setFilter() method, like this:
Filter filter = new MyFilterImpl(); logger.setFilter(filter);
The class MyFilterImpl should be your own implementation of the Filter interface. See the text on Filters to learn more about implementing your own Filter.
You can obtain the Filter in use by calling the getFilter() method, like this:
Filter filter = logger.getFilter();
Setting the Log Level
You can set the minimum log level of messages to be forwarded to the Handler‘s. Here is a code example:
Logger logger = Logger.getLogger("myLogger");
logger.setLevel(Level.INFO);
This example sets the minimum log level of messages to be forwarded, to Level.INFO. To see the hierarchy of log levels, read the text on Log Levels.
You can obtain the log level of a Logger using the getLevel() method:
logger.getLevel();
You can also check if a given log level would be logged, if you tried logging a message with that log level. You do so using the isLoggable() method, like this:
boolean isInfoLoggable = logger.isLoggable(Level.INFO);
Parent Logger
As mentioned elsewhere in this tutorial, the Logger‘s are organized into a hierarchy. That means, that a Loggercan have a parent Logger in the hierarchy. You can obtain the parent Logger of a given Logger using thegetParent() method. Here is an example:
Logger parent = logger.getParent();
You can also tell the Logger to use or not use the Parent logger when logging. You do so using thesetUseParentHandlers(), like this:
logger.setUseParentHandlers(false);
This example switched off the forwarding of log messages to the parent Logger‘s Handler‘s.
You can check if a Logger forwards log messages to its parent Logger using the methodgetUseParentHandlers(). Here is an example:
boolean useParentLogger = logger.getUseParentHandlers();
Additional Methods
The Logger class has a few more methods that I haven‘t covered here. These are minor features, like obtaining theResourceBundle in use by the Logger etc. You should check out the JavaDoc‘s for the complete list of utility methods.