Operating Systems: i5/OS
Personalize the table of contents and search results
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:
- Application code invokes the createCommonBaseEvent method on the EventFactory
class to create a CommonBaseEvent.
- Application code wraps CommonBaseEvent event in a CommonBaseEventLogRecord
record, and adds event-specific data.
- Application code calls the CommonBaseEvent event complete method.
- The CommonBaseEvent event invokes the ContentHandler completeEvent method.
- The ContentHandler handler adds XML template data to the CommonBaseEvent
event. Not all ContentHandler handlers support templates.
- The ContentHandler handler adds runtime data to the CommonBaseEvent event.
- Application code passes the CommonBaseEventLogRecord record to the logger
using the Logger.log method.
- Logger passes CommonBaseEventLogRecord record to Handlers.
- Handlers format data and write to the output device.
Procedure
Results
After completing all the above steps you will have a Common Base
event based on your configuration settings.
}
Generate Common Base Event content with the default event factory
Common Base Event content handler
Creating custom Common Base Event content handlers
Common Base Event factory home
Creating custom Common Base Event factory homes
Common Base Event factory context
Common Base Event factory
Related Reference
java.util.logging -- Java logging programming interface
Logger.properties file
|