Logging utility support

Log and Trace Analyzer provides standalone and plug-in support for the following logging utilities:

Java Logging (JSR-047)

Apache Jakarta Commons Logging

Apache Jakarta Log4J Logging

EMF Common Base Event V1.0.1

This support entails:

logging and XML formatting of Common Base Event log messages.

a logging agent sink for log messages to allow real-time monitoring via Log and Trace Analyzer.

This support is provided by the following plug-ins:

Logging Utility	Plug-in JARs
Java Logging (JSR-047)	org.eclipse.hyades.logging.core\hl14.jar
Apache Jakarta Commons Logging	org.eclipse.hyades.logging.core\hlcommons.jar
Apache Jakarta Log4J Logging	org.eclipse.hyades.logging.core\hllog4j.jar
EMF Common Base Event V1.0.1	org.eclipse.tptp.platform.logging.events\hlcbe101.jar

The following sections describe the details of each type of logging utility support, and provide pointers to samples that demonstrate how to use it..

Java Logging (JSR-047)

Logging Common Base Events
An extension of the java.util.logging.LogRecord class under the org.eclipse.hyades.logging.java14 package allows you to create a customized log record for logging an org.eclipse.hyades.logging.events.cbe.CommonBaseEvent in a java.util.logging.LogRecord. This org.eclipse.hyades.logging.java14.CommonBaseEventLogRecordextendsjava.util.logging.LogRecord and contains a reference to an org.eclipse.hyades.logging.events.cbe.CommonBaseEvent. All java.util.logging.LogRecord properties are mapped to one or more Common Base Event properties to maintain reflexivity for non-Common Base Event aware handlers and formatters.
Filtering Common Base Event log messages
An implementation of the java.util.logging.Filter interface under the org.eclipse.hyades.logging.java14 package only permits org.eclipse.hyades.logging.java14.CommonBaseEventLogRecords to be successfully logged.

XML Formatting of Common Base Event and Log Record log messages
An extension of the java.util.logging.Formatter abstract class under the org.eclipse.hyades.logging.java14 package allows you to configure handlers to format org.eclipse.hyades.logging.java14.CommonBaseEventLogRecord and java.util.logging.LogRecord log messages to XML. This org.eclipse.hyades.logging.java14.XmlFormatter formatter converts theorg.eclipse.hyades.logging.java14.CommonBaseEventLogRecord or java.util.logging.LogRecord log message to XML based on the Common Base Event v1.0.1 schema. When formatting, the log message is checked to see if it implements the org.eclipse.hyades.logging.core.IExternalizableToXml interface (e.g. org.eclipse.hyades.logging.java14.CommonBaseEventLogRecord). If so, theexternalizeCanonicalXmlString() API is called in place of XML serialization. Otherwise, the java.util.logging.LogRecord log message is converted to a Common Base Event object using the same mapping as in the org.eclipse.hyades.logging.events.cbe.CommonBaseEvent and serialized to XML by calling the externalizeCanonicalXmlString() API.

Logging agent sink
An extension of the java.util.logging.Handler abstract class under the org.eclipse.hyades.logging.java package allows loggers to be configured to log org.eclipse.hyades.logging.events.cbe.CommonBaseEvent and java.util.logging.LogRecord log messages to a logging agent.

This org.eclipse.hyades.logging.java.LoggingAgentHandler handler checks to see if the org.eclipse.hyades.logging.java14.CommonBaseEventLogRecord or java.util.logging.LogRecord log message that is logged to a logger can be logged based on the logger's and handler's filter and logging level. If the log message is to be logged, a logging agent is resolved with the same name as the logger that logs the message. Otherwise, you may use the org.eclipse.hyades.logging.java.SingleLoggingAgentHandler handler, which creates one logging agent, named Logging Agent Handler. The message is formatted in XML using an org.eclipse.hyades.logging.java.XmlFormatter and written to the logging agent.

Illustrative sample

A sample is provided to show how to leverage the support for JSR-047 Java Logging by illustrating the configuration and instrumentation required for new and existing users of the standalone and plug-in support for JSR-047 Java Logging. For more information, open File > New > Example... > Logging > JSR-047 Logging Sample.

Apache Jakarta Commons Logging

Logging Common Base Events
An implementation of the org.apache.commons.logging.Log interface under the org.eclipse.hyades.logging.commons package lets you create a logger for logging org.eclipse.hyades.logging.events.cbe.CommonBaseEvent, java.lang.Object and java.lang.Throwable log messages. This org.eclipse.hyades.logging.commons.Logger checks to see if org.eclipse.hyades.logging.events.cbe.CommonBaseEvent, java.lang.Object or java.lang.Throwable log message that is logged to a logger can be logged based on the logger's logging level. If the log message is to be logged, the org.eclipse.hyades.logging.events.cbe.CommonBaseEvents, java.lang.Object or java.lang.Throwable log message is formatted and logged. An implementation of the org.apache.commons.logging.LogFactory abstract class is provided which represents a proxy factory specific for org.eclipse.hyades.logging.commons.Logger instances. This org.eclipse.hyades.logging.commons.LoggerFactory proxy factory is intended for use in multiple class loader environments where one or more different types of loggers and their factories are required for each separate class loader, all utilizing the same Apache Commons binaries.

XML Formatting of Common Base Event, Object and Throwable log messages
The org.eclipse.hyades.logging.commons.Logger formats org.eclipse.hyades.logging.events.cbe.CommonBaseEvent, java.lang.Object and java.lang.Throwable log messages to XML based on the Common Base Event v1.0.1 schema. When formatting, the log message is checked to see if it implements the org.eclipse.hyades.logging.core.IExternalizableToXml interface (for example, org.eclipse.hyades.logging.events.cbe.CommonBaseEvent). If so, theexternalizeCanonicalXmlString() API is called in place of XML serialization. Otherwise, the java.lang.Object or java.lang.Throwable log message is converted to a Common Base Event object using the org.eclipse.hyades.logging.events.cbe.util.EventHelpers.convertObjectToCommonBaseEvent() methods and serialized to XML by calling the externalizeCanonicalXmlString() API.

Logging agent sink
The org.eclipse.hyades.logging.commons.Logger logs org.eclipse.hyades.logging.events.cbe.CommonBaseEvent, java.lang.Object and java.lang.Throwable log messages to a logging agent. If the log message is to be logged, a logging agent is resolved with the same name as the logger that logs the message. The message is formatted to XML and written to the logging agent.

Log file sink
An implementation of the org.apache.commons.logging.Log interface under the org.eclipse.hyades.logging.commons package lets you create a logger for logging org.eclipse.hyades.logging.events.cbe.CommonBaseEvent, java.lang.Object and java.lang.Throwable log messages to a local file. This org.eclipse.hyades.logging.commons.FileLogger checks to see if the org.eclipse.hyades.logging.events.cbe.CommonBaseEvent, java.lang.Object or java.lang.Throwable log message that is logged to a logger can be logged based on the logger's logging level. If the log message is to be logged, the org.eclipse.hyades.logging.events.cbe.CommonBaseEvent, java.lang.Object or java.lang.Throwable log message is formatted to XML and logged to a local file. An implementation of the org.apache.commons.logging.LogFactory abstract class is provided which represents a proxy factory specific for org.eclipse.hyades.logging.commons.FileLogger instances. This org.eclipse.hyades.logging.commons.FileLoggerFactory proxy factory is intended for use in multiple class loader environments where one or more different types of loggers and their factories are required for each separate class loader, all utilizing the same Apache Commons binaries.

Illustrative sample

A sample is provided to show how to leverage the support for Apache Jakarta Commons Logging by illustrating the configuration and instrumentation required for new and existing users of the standalone and plug-in support for Apache Jakarta Commons Logging. For more information, see File > New > Example... > Logging > Apache Commons Logging Sample.

Apache Jakarta Log4J Logging

Logging Common Base Events
The message property of the org.apache.log4j.spi.LoggingEvent log message lets you log an org.eclipse.hyades.logging.events.cbe.CommonBaseEvent.
Filtering Common Base Event log messages
An extension of the org.apache.log4j.spi.Filter abstract class under the org.eclipse.hyades.logging.log4j package only permits org.eclipse.hyades.logging.events.cbe.CommonBaseEvents to be successfully logged.
XML Formatting of Common Base Event and Log Record log messages
An extension of the org.apache.log4j.Layout abstract class under the org.eclipse.hyades.logging.log4j package allows you to configure appenders to format org.eclipse.hyades.logging.events.cbe.CommonBaseEvent and org.apache.log4j.spi.LoggingEvent log messages to XML. This org.eclipse.hyades.logging.log4j.XmlLayout formatter converts theorg.eclipse.hyades.logging.events.cbe.CommonBaseEvent or org.apache.log4j.spi.LoggingEvent log message to XML based on the Common Base Event v1.0.1 schema. When formatting, the log message is checked to see if the message property of the org.apache.log4j.spi.LoggingEvent implements the org.eclipse.hyades.logging.core.IExternalizableToXml interface (for example, org.eclipse.hyades.logging.events.cbe.CommonBaseEvent). If so, the externalizeCanonicalXmlString() API is called in place of XML serialization. Otherwise, the org.apache.log4j.spi.LoggingEvent log message is converted to a Common Base Event object using the org.eclipse.hyades.logging.events.cbe.util.EventHelpers.convertObjectToCommonBaseEvent() methods and serialized to XML by calling the externalizeCanonicalXmlString() API.

Logging agent sink
An extension of the org.apache.log4j.AppenderSkeleton abstract class under the org.eclipse.hyades.logging.log4j package allows loggers to be configured to log org.eclipse.hyades.logging.events.cbe.CommonBaseEvent and org.apache.log4j.spi.LoggingEvent log messages to a logging agent.

This org.eclipse.hyades.logging.log4j.LoggingAgentAppender appender checks to see if the org.eclipse.hyades.logging.events.cbe.CommonBaseEvent and org.apache.log4j.spi.LoggingEvent log message that is logged to a logger can be logged based on the logger's and appender's filter and logging level. If the log message is to be logged, a Logging Agent is resolved with the same name as the logger that logs the message. Otherwise, you may use the org.eclipse.hyades.logging.log4j.SingleLoggingAgentAppender appender which creates one logging agent, named Logging Agent Appender. The message is formatted to XML using an org.eclipse.hyades.logging.log4j.XmlLayout and written to the logging agent.

Illustrative sample

A sample is provided to show how to leverage the support for Apache Jakarta Log4J Logging by illustrating the configuration and instrumentation required for new and existing users of the standalone and plug-in support for Apache Jakarta Log4J Logging. For more information, see File > New > Example... > Logging > Apache Log4J Logging Sample.

EMF Common Base Event V1.0.1

Illustrative sample

A sample is provided to show how to leverage the support for EMF Common Base Events by creating and configuring Common Base Events using the Common Base Event XML file template Event Factory. For more information, see File > New > Example... > Logging > EMF Common Base Event v1.0.1 Sample.

Related concepts
Common Base Event model