Logging with Common Base Event API and the Java logging API

In cases where the events that are generated by the Java logging API are insufficient to describe the event that needs capturing, you can create Common Base Events with the Common Base Event factory APIs.

When you create a Common Base Event, you can add data to the Common Base Event before it is logged. The following diagram illustrates how application code can create and log Common Base Events:

Overview

WebSphere Application Server is configured to use an event factory that automatically populates WebSphere Application Server-specific information into the Common Base Events that it generates. In general, it is good practice to create events using the WebSphere Application Server default Common Base Event factory because this approach ensures consistency of Common Base Event content across events. However, you can create and use other Common Base Event factories. Common Base Events are initiated and logged in the following sequence:

1. Application code invokes the createCommonBaseEvent method on the EventFactory class to create a CommonBaseEvent.

2. Application code wraps CommonBaseEvent event in a CommonBaseEventLogRecord record, and adds event-specific data.

3. Application code calls the CommonBaseEvent event complete method.

4. The CommonBaseEvent event invokes the ContentHandler completeEvent method.

5. The ContentHandler handler adds XML template data to the CommonBaseEvent event. Not all ContentHandler handlers support templates.

6. The ContentHandler handler adds runtime data to the CommonBaseEvent event.

7. Application code passes the CommonBaseEventLogRecord record to the logger using the Logger.log method.

8. Logger passes CommonBaseEventLogRecord record to Handlers.

9. Handlers format data and write to the output device.

Procedure

• You can use the default Common Base Event factory to generate content. Read Generate Common Base Event content with the default event factory for more information.

• If you do not wish to use the default event factory, you can create custom content handlers and event factories.

  1. Create a custom factory home. Read Creating custom Common Base Event factory homes.

  2. Create a custom content handler. Read Creating custom Common Base Event content handlers.

Results

After completing all the above steps you will have a Common Base event based on your configuration settings.

Related Reference