5.2. Logging with the JBoss Logging Framework

Procedure 5.1. Add Logging to an Application

1. Add imports

   Add the import statements for the JBoss Logging class namespaces that you will be using. At a minimum you will need to import import org.jboss.logging.Logger.

   import org.jboss.logging.Logger;

   Copy to Clipboard Toggle word wrap

2. Create a Logger object

   Create an instance of org.jboss.logging.Logger and initialize it by calling the static method Logger.getLogger(Class). Red Hat recommends creating this as a single instance variable for each class.

   private static final Logger LOGGER = Logger.getLogger(HelloWorld.class);

   Copy to Clipboard Toggle word wrap

3. Add logging messages

   Add calls to the methods of the Logger object to your code where you want it to send log messages. The Logger object has many different methods with different parameters for different types of messages. The easiest to use are:

   debug(Object message)

   info(Object message)

   error(Object message)

   trace(Object message)

   fatal(Object message)

   These methods send a log message with the corresponding log level and the message parameter as a string.

   LOGGER.error("Configuration file not found.");

   Copy to Clipboard Toggle word wrap
   For the complete list of JBoss Logging methods refer to the org.jboss.logging package in the JBoss EAP 6 API Documentation.