Eclipse plugin development: logging errors in log4j to view errors

I am trying to make my log from log4j to go to the Eclipse Log Error view in my plugin.

I have two external packages:

  • Bundle 1: A plug-in development project based on existing JARs containing the log4j library has been created.
  • Bundle 2: created an empty plugin development project. Added log4j.properties to it and a new class "VirtualConsole", which extends "ConsoleAppender".

This is what my log4j.properties looks like:

# Set root logger level to debug and its only appender to default.
log4j.rootLogger=debug, default
# default is set to be a ConsoleAppender.
log4j.appender.default=VirtualConsole
# default uses PatternLayout.
log4j.appender.default.layout=org.apache.log4j.PatternLayout
log4j.appender.default.layout.ConversionPattern=%-4r [%t] %-5p %c %x - %m%n

And here is what my VirtualConsole looks like:

import org.apache.log4j.ConsoleAppender;
import org.apache.log4j.Level;
import org.apache.log4j.spi.LoggingEvent;
import org.eclipse.core.runtime.IStatus;
import org.eclipse.core.runtime.Status;
import org.eclipse.ui.statushandlers.StatusManager;

public class VirtualConsole extends ConsoleAppender {

    @Override
    public void append(LoggingEvent event) {
        int level = IStatus.INFO;
        if (event.getLevel().equals(Level.ERROR))
            level = IStatus.ERROR;
        IStatus status = new Status(level, "myplugin",
                                event.getMessage().toString());
        StatusManager.getManager().handle(status, StatusManager.LOG);

        //and the normal logging
        super.append(event);
    }
}

. , , Eclipse, " > > Eclipse", () - , , - .

, Eclipse " ", ... . , , .

- ? .


, :

Manifest.MF "bundle.log4jProperties":

Manifest-Version: 1.0
Bundle-ManifestVersion: 2
Bundle-Name: Log4jProperties
Fragment-Host: bundle.slf4j
Bundle-SymbolicName: bundle.log4jProperties
Bundle-Version: 1.0.1
Bundle-RequiredExecutionEnvironment: JavaSE-1.6
Require-Bundle: org.eclipse.core.runtime;bundle-version="3.7.0",
    bundle.slf4j
Eclipse-RegisterBuddy: bundle.slf4j

log4j.properties "bundle.log4jProperties":

# Set root logger level to DEBUG and its only appender to A1.
log4j.rootLogger=DEBUG, A1
log4j.logger.org.hibernate.type=ERROR

# A1 is set to be a ConsoleAppender.
log4j.appender.A1=bundle.log4jProperties.ErrorLogAppender

# A1 uses PatternLayout.
log4j.appender.A1.layout=org.apache.log4j.PatternLayout
log4j.appender.A1.layout.ConversionPattern=%-4r [%t] %-5p %c %x - %m%n

ErrorLogAppender.java "bundle.log4jProperties" ( "bundle.log4jProperties", src):

package bundle.log4jProperties;

import org.apache.log4j.AppenderSkeleton;
import org.apache.log4j.Level;
import org.apache.log4j.spi.LoggingEvent;
import org.apache.log4j.spi.ThrowableInformation;
import org.eclipse.core.runtime.ILog;
import org.eclipse.core.runtime.IStatus;
import org.eclipse.core.runtime.Platform;
import org.eclipse.core.runtime.Status;


public class ErrorLogAppender extends AppenderSkeleton {

    @Override
    public void close() {}

    @Override
    public boolean requiresLayout() {
            return false;
    }

    @Override
    protected void append(LoggingEvent event) {
            //get the platform log
            ILog log = Platform.getLog(Platform.getBundle
                    ("bundle.log4jProperties"));

            //create an IStatus status
            IStatus status = new Status(getLevel(event.getLevel()),
                    "myPlugin",
                    getCode(event), 
                    getMessage(event), 
                    getThrowable(event));

            //log the status
            log.log(status);
    }

    private int getLevel(Level level) {
            int severity;
            if (level.equals(Level.ALL) || 
                level.equals(Level.ERROR) || 
                level.equals(Level.FATAL))
                    severity = IStatus.ERROR;
            else if (level.equals(Level.WARN))
                    severity = IStatus.WARNING;
            else if (level.equals(Level.INFO))
                    severity = IStatus.INFO;
            else severity = IStatus.INFO;
            return severity;
    }

    private int getCode(LoggingEvent event) {
            return (int) event.getTimeStamp();
    }
    private String getMessage(LoggingEvent event) {
            return event.getMessage().toString();
    }
    private Throwable getThrowable(LoggingEvent event) {
            ThrowableInformation info = event.getThrowableInformation();
            if (info != null)
                    return info.getThrowable();
            else return null;
    }
}

"bundle.slf4j", 3 jar: Manifest.MF:

Manifest-Version: 1.0
Bundle-ManifestVersion: 2
Bundle-Name: Slf4j
Bundle-SymbolicName: bundle.slf4j
Bundle-Version: 1.0.1
Bundle-ClassPath: slf4j-api-1.7.5.jar,
 slf4j-log4j12-1.7.5.jar,
 log4j-1.2.17.jar
Bundle-Vendor: apache
Export-Package: org.apache.log4j,
 org.apache.log4j.chainsaw,
 org.apache.log4j.config,
 org.apache.log4j.helpers,
 org.apache.log4j.jdbc,
 org.apache.log4j.jmx,
 org.apache.log4j.lf5,
 org.apache.log4j.lf5.util,
 org.apache.log4j.lf5.viewer,
 org.apache.log4j.lf5.viewer.categoryexplorer,
 org.apache.log4j.lf5.viewer.configure,
 org.apache.log4j.net,
 org.apache.log4j.nt,
 org.apache.log4j.or,
 org.apache.log4j.or.jms,
 org.apache.log4j.or.sax,
 org.apache.log4j.pattern,
 org.apache.log4j.rewrite,
 org.apache.log4j.spi,
 org.apache.log4j.varia,
 org.apache.log4j.xml,
 org.slf4j,
 org.slf4j.helpers,
 org.slf4j.impl,
 org.slf4j.spi
Bundle-RequiredExecutionEnvironment: JavaSE-1.6
Eclipse-BuddyPolicy: registered

Eclipse Eclipse, . , , , , , ?

. feature.xml, updateite, ( , ):

<requires>
    <import plugin="bundle.slf4j" version="1.0.1" match="greaterOrEqual"/>
</requires>

<plugin
    id="bundle.slf4j"
    download-size="0"
    install-size="0"
    version="0.0.0"/>

<plugin
    id="bundle.log4jProperties"
    download-size="0"
    install-size="0"
    version="0.0.0"
    fragment="true"
    unpack="false"/>

bundle.log4jProperties , , . - , , feature.xml( "", ) "" , ? , feature.xml -.

, . . , -, , . : . , ?

+4

All Articles